com.webos.service.applicationmanager

Note
This API has been available since API level 11.

API Summary

Provides methods for managing application life cycle, application information, LaunchPoint list.

Overview of the API

Methods

addLaunchPoint

ACG: application.launcher

Added: API level 11

Description

Adds a dynamic launchpoint. According to the information on launchpoint, application is displayed in the Launcher.

If a parameter is not defined, SAM set the LP's parameter value same as appInfo's value.

Parameters

Name

Required

Type

Description

Required

String

Indicates the application ID to be added.

launchPointId

Optional

String

Indicates the launchpoint ID to be added.

title

Optional

String

Indicates the launchpoint title.

icon

Optional

String

Indicates the path of the icon image displayed for the launchpoint.

bgImage

Optional

String

Indicates the path of the background image displayed to the user when the user hovers over the launchpoint.

bgColor

Optional

String

Indicates the background color for the launchpoint. It will be displayed when the bgImage is not provided or unable to display. A color can be specified as a hex value or as a HTML color name.

Format: color hex code (ex. #000000(black))

http://www.color-hex.com/

imageForRecents

Optional

String

Indicates the path of the image displayed in the "Recents" tile.

iconColor

Optional

String

Indicates the background color for the application tile. The application tile is displayed in the Home, the Launcher, and the Recent screen.

Format: color hex code (ex. #000000(black))

http://www.color-hex.com/

largeIcon

Optional

String

Indicates the path of the large icon (130x130 pixels) displayed in the top left corner of the screen, when the user hovers over an application tile in the Launcher.

Note: This file path is relative to the appinfo.json file.

appDescription

Optional

String

Indicates a brief description for the launchpoint.

Note: The appDescription cannot exceed 60 characters.

params

Optional

Object: params

If params is used, it should contain information on the launchpoint.

bgImages

Optional

String array

Indicates the paths of the background images displayed to the user when the user hovers over the launchpoint.

tileSize

Optional

String

Indicates the tile size on UI.

Possible values are

normal
large.

Default: normal

Note:

The large tile hints that UI should make this tile larger than normal (2x).
Usually, large size may be used for promotional application.

unmovable

Optional

Boolean

Indicates if the launchpoint position is movable or not.

Possible values are:

true: The launchpoint position cannot be moved by the user.
false: the launchpoint position can be moved by the user.

Default: false

userData

Optional

String

Indicates the additional data that may be used for analytical purposes. The userData will be logged when the user interacts with it in Launcher.

policyCategory

Optional

String

Indicates the category(group) of the launch point. The value should be the one of below mapping table.

*$RESERVED_VALUE is for special callers to be controlled by LPM.

Value	Launch Point Type	position
default	Any	9
*$RESERVED_VALUE	$RESERVED_LP	$RESERVED_POSITION

supportI18nTitle

Optional

Boolean

If "supportI18nTitle" is set to true, i18n will be supported for title when any information of this launch point is changed.
If "supportI18nTitle" is set to false, i18n will be supported for title when any information of this launch point is changed.
The default value of supportI18nTitle is true

favicon

Optional

String

Indicates the paths of the favorite icon for the launchpoint.

relaunch

Optional

Boolean

If it is set to true, the app will be fresh-launched(re-randering) whenever user clicks the launchpoint.

Note: This parameter is deprecated in IvyLeague.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the 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.
launchPointId	Optional	String	Indicates the launchpoint ID to be added.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.
errorCode	Optional	Number	The error code for the failed operation.

Error Codes Reference

Error Code	Error Text	Error Description
None	invalid json request	Invalid JSON request.

Example

Example code

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/addLaunchPoint '{
"id":"com.webos.app.test",
"title":"TestLP"
}'

Response:

{
"launchPointId":"178884",
"returnValue":true
}

close

ACG: application.launcher

Added: API level 11

Description

Closes an application.

Note A: At least one parameter is required. ('id', 'launchPointId', 'instanceId')

Note B: Don't use this API in TV and signage. The API is deprecated in the platforms.

Parameters

Name	Required	Type	Description
id	Optional	String	Indicates the id of the application.
launchPointId	Optional	String	Indicates the launchPointId of the application.
instanceId	Optional	String	Indicates the instanceId of the application.

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.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.
errorCode	Optional	Number	The error code for the failed operation.
processId	Optional	String	Indicates the processId of the closed application.
instanceId	Optional	String	Indicates the instanceId of the running application.
launchPointId	Optional	String	Indicates the launchPointId of the running application.
appId	Optional	String	Indicates the appId of the running application.
displayId	Optional	Number (int32_t)	Indicates the displayId of running application.

Error Codes Reference

Error Code	Error Text	Error Description
None	Invalid processId specified	Invalid processId is specified.
None	Not string	Invalid type value.
None	Unknown Process	Unknown processId.

Example

Example code

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/close '{
   "id":"com.webos.app.test"
}'
{
   "launchPointId": "com.webos.app.test_default",
   "appId": "com.webos.app.test",
   "returnValue": true,
   "displayId": 0,
   "instanceId": "a3effa8b-fe4a-4f5c-953b-0d326c0d2ef20"
}

closeByAppId

ACG: application.launcher

Added: API level 11

Description

Closes an application by appId in the system manager.

Parameters

Name

Required

Type

Description

Optional

String

Indicates the id of the application.

reason

Optional

String

Indicates the reason of why the app was closed. Subscribers who are watching app status will get the reason.

Note: This parameter is only for reserved caller such as surfacemanager. Other services or apps should not use this parameter.

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 "errorText" field for details.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.
instanceId	Optional	String	Indicates the instanceId of the running application.
launchPointId	Optional	String	Indicates the launchPointId of the running application.
displayId	Optional	String	Indicates the displayId of the running application.

Error Codes Reference

Error Code	Error Text	Error Description
None	invalid parameter	invalid parameter.
None	no app description	Invalid appId is specified. That is, the 'id' parameter is empty.
None	Not string	Invalid type value.
None	app is not running	Application is not running.

Example

Example code

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/closeByAppId '{
"id":"com.webos.app.test"
}'

dev/close

ACG: application.devmode

Added: API level 23

Description

Closes application by either of application id, instance id and launchpoint id .

Note: At least one parameter is required. Available only in developer mode (devmode)

Parameters

Name	Required	Type	Description
id	Optional	String	Indicates the id of the application. Note: At least one parameter of 'id', 'launchPointId', or 'instanceId' is mandatory.
launchPointId	Optional	String	Indicates the launchPointId of the application. Note: At least one parameter of 'id', 'launchPointId', or 'instanceId' is mandatory.
instanceId	Optional	String	Indicates the instanceId of the application. Note: At least one parameter of 'id', 'launchPointId', or 'instanceId' is mandatory.

Name

Required

Type

Description

Optional

String

Indicates the id of the application.

Note: At least one parameter of 'id', 'launchPointId', or 'instanceId' is mandatory.

launchPointId

Optional

String

Indicates the launchPointId of the application.

Note: At least one parameter of 'id', 'launchPointId', or 'instanceId' is mandatory.

instanceId

Optional

String

Indicates the instanceId of the application.

Note: At least one parameter of 'id', 'launchPointId', or 'instanceId' is mandatory.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Operation is successful. false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	The reason for the failure of the operation. See the 'Error Codes' section of this method for details.
processId	Optional	String	Process ID of the closed application.
launchPointId	Optional	String	Launch point ID of the running application.
appId	Optional	String	App ID of the running application.
displayId	Optional	Number (int32_t)	Display ID of running application.

Error Codes Reference

Error Code	Error Text	Error Description
None	app is not running	app is not running
2	Only Dev app should be closed using /dev category_API	Only Dev app cane be closed using /dev category_API
3	invalid parameter	invalid parameter

Example

Example : Closing application by app id

1. Launch the application.

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/launch '{"id":"com.lgsi.test.app" }'

Response:

{
"launchPointId": "com.lgsi.test.app_default",
"appId": "com.lgsi.test.app",
"instanceId": "7bf743c6-140d-4daf-817a-ef86d5d2d0060",
"displayId": 0,
"returnValue": true
}

2. Close the application.

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/dev/close '{"id":"com.lgsi.test.app"}'

Response:

{
"launchPointId": "com.lgsi.test.app_default",
"appId": "com.lgsi.test.app",
"instanceId": "7bf743c6-140d-4daf-817a-ef86d5d2d0060",
"displayId": 0,
"returnValue": true
}

Example : Closing application by app instanceId

1. Launch the application.

# luna-send -n 1 -f luna://com.webos.applicationManager/launch '{"id":"com.domain.app"}'

Response:

{
"launchPointId": "com.domain.app_default",
"appId": "com.domain.app",
"instanceId": "74a77a9c-1779-4f9c-92c2-87d3a27650260",
"displayId": 0,
"returnValue": true
}

2. Close the application.

# luna-send -n 1 -f luna://com.webos.applicationManager/dev/close '{"instanceId":"74a77a9c-1779-4f9c-92c2-87d3a27650260"}'

Response:

{
"launchPointId": "com.domain.app_default",
"appId": "com.domain.app",
"instanceId": "74a77a9c-1779-4f9c-92c2-87d3a27650260",
"displayId": 0,
"returnValue": true
}

Example : Closing application by app launchPointId

1. Launch the application.

# luna-send -n 1 -f luna://com.webos.applicationManager/launch '{"id":"com.domain.app"}'

Response:

{
"launchPointId": "com.domain.app_default",
"appId": "com.domain.app",
"instanceId": "93cb3c90-4837-4514-8fb7-34645cc11dc90",
"displayId": 0,
"returnValue": true
}

2. Close the application.

# luna-send -n 1 -f luna://com.webos.applicationManager/dev/close '{"launchPointId":"com.domain.app_default"}'

Response:

{
"launchPointId": "com.domain.app_default",
"appId": "com.domain.app",
"instanceId": "93cb3c90-4837-4514-8fb7-34645cc11dc90",
"displayId": 0,
"returnValue": true
}

dev/closeByAppId

ACG: application.devmode

Added: API level 11

Description

Closes an application by the application id.

Note: 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	Indicates the application id to be closed.

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. See the "Error Codes" section of this method for details.
instanceId	Optional	String	Indicates the instanceId of running application.
launchPointId	Optional	String	Indicates the launchPointId of running application.
displayId	Optional	Number (int32_t)	Indicates the displayId of the running application.

Error Codes Reference

Error Code	Error Text	Error Description
None	app is not running	The application that you want to close is not running.
None	no app description	Passed id is invalid. That is, id parameter is empty.
None	Not string	Passed value is an invalid type.
None	invalid parameter	Passed parameter is invalid.
None	Only Dev app should be closed using /dev category_API	In devmode, an application must be closed by dev/closeByAppId method.

Example

Example code

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/dev/closeByAppId '{
"id":"com.webos.app.test"
}'

dev/listApps

ACG: application.devmode

Added: API level 11

Description

Lists all of the registered applications.

Note:

Available only in developer mode (devmode). To enable devmode, call 'com.webos.service.devmode' ('setDevMode') with value 'true'.
Works for devmode app type.

Parameters

Name	Required	Type	Description
subscribe	Optional	String	Indicates if subscribed to get notifications. Possible values are: true: Subscribe to get notifications false: Do not subscribe Default: false
properties	Optional	String array	Indicates the name of properties to be extracted from appinfo.json file.

Name

Required

Type

Description

Optional

String

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe to get notifications
false: Do not subscribe

Default: false

properties

Optional

String array

Indicates the name of properties to be extracted from appinfo.json file.

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. See the "API Error Codes Reference" for more information.

subscribed

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribed to get notifications
false: Not subscribed

apps

Required

Object array: appInfo

If the dev/listApps method succeeds, the array of the applications will be returned.

Subscription 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. See the "API Error Codes Reference" for more information.
apps	Required	Object array: appInfo	Either this, or app will be returned. apps is returned when all apps' information has been changed by language change.
app	Required	Object array: appInfo	Either this, or apps will be required. app is returned the information of an app which has been installed/updated/removed.
subscribed	Required	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribed to get notifications false: Not subscribed Default: true
change	Optional	String	Indicates the reason for the change in the app information. Possible values are: added updated removed
changeReason	Optional	String	Indicates the reason why the target app is added/removed.

Example

Example: Success

This method returns information for all apps at first.

# luna-send -i -f luna://com.webos.service.applicationmanager/dev/listApps '{
"subscribe":true
}'

Response:

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

When an app is update/removed/installed, the method returns only changed app's information

{
"subscribed":true,
"change":"removed",
"returnValue":true,
"app":{
"..."
}
}

dev/managerInfo

ACG: application.devmode

Added: API level 23

Description

Provides information provided by listLaunchPoints,running, and listApps APIs. Gets all of the launchpoints and lists all of the registered applications. Lists the background/foreground applications and their process IDs that are running on device.

Parameters

None

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Operation is successful. false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	The reason for the failure of the operation. See the 'Error Codes' section of this method for details.
launchPoints	Optional	Object array: launchPoints	Array of the launch points.
lunaTasks	Optional	Object array	Provides information of caller of dev/managerInfo API.
running	Optional	Object array: running	Indicates the background/foreground applications and their process IDs that are running on device.
apps	Optional	Object array: appInfo	Lists all of the registered applications.

Error Codes Reference

Error Code	Error Text	Error Description
3	invalid parameter	For invalid parameter.

Example

Example

# luna-send -i -f luna://com.webos.applicationManager/dev/managerInfo '{}'

Response:

{
"launchPoints":[
{
"checkUpdateOnLaunch":true,
"title":"Bare App",
"icon":"/usr/palm/applications/bareapp/icon.png",
"tileSize":"normal",
"inAppSetting":false,
"miniicon":"icon.png",
"folderPath":"/usr/palm/applications/bareapp",
"lptype":"default",
"transparent":false,
"icons":[

],
"version":"1.0.1",
"hasPromotion":false,
"lockable":true,
"trustLevel":"default",
"bgImage":"",
"systemApp":true,
"launchPointId":"bareapp_default",
"main":"index.html",
"visible":true,
"largeIcon":"/usr/palm/applications/bareapp/icon.png",
"privilegedJail":false,
"inspectable":false,
"imageForRecents":"",
"defaultWindowType":"card",
"vendor":"LG Electronics, Inc.",
"accessibility":{
"supportsAudioGuidance":false
},
"deeplinkingParams":"",
"type":"web",
"spinnerOnLaunch":true,
"id":"bareapp",
"disableBackHistoryAPI":false,
"favicon":"",
"handlesRelaunch":false,
"noSplashOnLaunch":false,
"removable":false,
"unmovable":false,
"uiRevision":"2"
},
{
"v8SnapshotFile":"snapshot_blob.bin",
"checkUpdateOnLaunch":true,
"requiredPermissions":[
"com.example.service.iotivity.client.group",
"com.example.service.iotivity.server.group",
"notification.operation"
],
"title":"IoTivity Sampler",
"icon":"/usr/palm/applications/com.example.app.iotivity/icon.png",
"tileSize":"normal",
"inAppSetting":false,
"folderPath":"/usr/palm/applications/com.example.app.iotivity",
"lptype":"default",
"transparent":false,
"version":"1.0.0",
"trustLevel":"default",
"hasPromotion":false,
"lockable":true,
"icons":[

],
"bgImage":"",
"launchPointId":"com.example.app.iotivity_default",
"systemApp":true,
"main":"index.multi.html",
"visible":true,
"largeIcon":"",
"privilegedJail":false,
"inspectable":false,
"imageForRecents":"",
"defaultWindowType":"card",
"vendor":"LGE",
"type":"web",
"deeplinkingParams":"",
"accessibility":{
"supportsAudioGuidance":false
},
"spinnerOnLaunch":true,
"id":"com.example.app.iotivity",
"disableBackHistoryAPI":false,
"favicon":"",
"handlesRelaunch":false,
"noSplashOnLaunch":false,
"removable":false,
"unmovable":false,
"usePrerendering":true,
"uiRevision":2
}
],
"returnValue":true,
"lunaTasks":[
{
"caller":"com.webos.lunasend-1851",
"kind":"/dev/managerInfo"
}
],
"running":[
{
"appType":"web",
"displayId":0,
"instanceId":"03419c62-edad-4031-8ffb-c2494170befc0",
"launchPointId":"com.webos.app.volume_default",
"webprocessid":"1161",
"id":"com.webos.app.volume",
"processid":"-1",
"defaultWindowType":"system_ui"
},
{
"appType":"web",
"displayId":0,
"instanceId":"0b4c885e-e9c2-4923-9ad3-2ff663cc3c320",
"launchPointId":"com.webos.app.notification_default",
"webprocessid":"1156",
"id":"com.webos.app.notification",
"processid":"434",
"defaultWindowType":"system_ui"
},
{
"appType":"web",
"displayId":0,
"instanceId":"457dcbb0-76ab-4fa7-9c0f-ffa9cbca44110",
"launchPointId":"bareapp_default",
"webprocessid":"1043",
"id":"bareapp",
"processid":"434",
"defaultWindowType":"card"
},
{
"appType":"web",
"displayId":0,
"instanceId":"61a9142a-f21f-4ab1-ac37-2aeeed660cb50",
"launchPointId":"com.webos.app.home_default",
"webprocessid":"1064",
"id":"com.webos.app.home",
"processid":"434",
"defaultWindowType":"system_ui"
}
],
"apps":[
{
"checkUpdateOnLaunch":true,
"title":"Bare App",
"icon":"icon.png",
"tileSize":"normal",
"inAppSetting":false,
"miniicon":"icon.png",
"folderPath":"/usr/palm/applications/bareapp",
"transparent":false,
"version":"1.0.1",
"icons":[

],
"hasPromotion":false,
"lockable":true,
"trustLevel":"default",
"systemApp":true,
"largeIcon":"icon.png",
"main":"index.html",
"visible":true,
"privilegedJail":false,
"inspectable":false,
"defaultWindowType":"card",
"vendor":"LG Electronics, Inc.",
"deeplinkingParams":"",
"type":"web",
"accessibility":{
"supportsAudioGuidance":false
},
"spinnerOnLaunch":true,
"id":"bareapp",
"disableBackHistoryAPI":false,
"handlesRelaunch":false,
"noSplashOnLaunch":false,
"removable":false,
"unmovable":false,
"uiRevision":"2"
},
{
"v8SnapshotFile":"snapshot_blob.bin",
"checkUpdateOnLaunch":true,
"requiredPermissions":[
"com.example.service.iotivity.client.group",
"com.example.service.iotivity.server.group",
"notification.operation"
],
"title":"IoTivity Sampler",
"icon":"icon.png",
"tileSize":"normal",
"inAppSetting":false,
"folderPath":"/usr/palm/applications/com.example.app.iotivity",
"transparent":false,
"version":"1.0.0",
"icons":[

],
"hasPromotion":false,
"lockable":true,
"trustLevel":"default",
"systemApp":true,
"main":"index.multi.html",
"visible":true,
"privilegedJail":false,
"inspectable":false,
"defaultWindowType":"card",
"accessibility":{
"supportsAudioGuidance":false
},
"deeplinkingParams":"",
"type":"web",
"vendor":"LGE",
"spinnerOnLaunch":true,
"id":"com.example.app.iotivity",
"disableBackHistoryAPI":false,
"handlesRelaunch":false,
"noSplashOnLaunch":false,
"removable":false,
"unmovable":false,
"usePrerendering":true,
"uiRevision":2
}
]
}

dev/running

ACG: application.devmode

Added: API level 11

Description

Lists the background/foreground applications and their process IDs that are running on the webOS platform.

Note:

Available only in developer mode (devmode). To enable devmode, call 'com.webos.service.devmode' ('setDevMode') with value 'true'.
Works for devmode app type.

Parameters

Name	Required	Type	Description
subscribe	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribe to get notifications false: Not subscribed Default: false

Name

Required

Type

Description

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe to get notifications
false: Not subscribed

Default: false

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. Note: returnValue will always contain true.
subscribed	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribe to get notifications false: Not subscribed
running	Required	Object array: running	If the dev/running method succeeds, the array of the running applications will be returned.

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.

Note: returnValue will always contain true.

subscribed

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe to get notifications
false: Not subscribed

running

Required

Object array: running

If the dev/running method succeeds, the array of the running applications will be returned.

Subscription 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. See the API Error Codes Reference for more information. Note: returnValue will always contain true.
subscribed	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribe to get notifications false: Not subscribed
running	Required	Object array: running	If the dev/running method succeeds, the array of the running applications will be returned

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. See the API Error Codes Reference for more information.

Note: returnValue will always contain true.

subscribed

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe to get notifications
false: Not subscribed

running

Required

Object array: running

If the dev/running method succeeds, the array of the running applications will be returned

Example

Example: Success

# luna-send -i -f luna://com.webos.service.applicationmanager/dev/running '{
"subscribe":true
}'

Response:

{
"subscribed":true,
"running":[
{
"id":"com.webos.app.test",
"webprocessid":"",
"defaultWindowType":"card",
"appType":"native",
"processid":"1176"
}
],
"returnValue":true
}

getAppBasePath

ACG: application.operation

Added: API level 11

Description

Gets the path of the application.

Note: This API is useful to get base directory path of installed application.

Parameters

Name	Required	Type	Description
appId	Required	String	Indicates the appId.

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 "errorText" field for details.
appId	Optional	String	Indicates the appId.
basePath	Optional	String	Indicates the application path.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.
errorCode	Optional	Number	The error code for the failed operation.

Error Codes Reference

Error Code	Error Text	Error Description
None	Not allowed. Allow only for the info of calling app itself.	Not allowed. Allow only for the information of calling application itself.
None	Error parsing request:Missing required key	Missing required key.
None	Error parsing request:Not string	Invalid type value.

Example

Example code

# luna-send -n 1 -a "bareapp" -f luna://com.webos.service.applicationmanager/getAppBasePath '{
"appId":"bareapp"
}'

getAppInfo

ACG: application.operation

Added: API level 11

Description

Gets the application information.

Note: The information is generated from appinfo.json file.

Parameters

Name	Required	Type	Description
id	Required	String	Indicates the id of the application.
properties	Optional	String array	Indicates the value to be extracted from appinfo.json file.

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 "errorText" field for details.
appId	Optional	String	Indicates the appld.
appInfo	Optional	Object: appInfo	If the getAppinfo method succeeds, the appInfo object contains information about the application.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.
errorCode	Optional	Number	The error code for the failed operation.

Error Codes Reference

Error Code	Error Text	Error Description
None	Invalid appId specified	Invalid appId is specified. That is, the 'id' parameter is empty.
None	parameters must contain a 'id' (string)	Parameters must contain an 'id' (string).
None	Invalid appId specified OR Unsupported Application Type	Invalid appId is specified or an unsupported application type.

Example

Example: Success

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/getAppInfo '{
"id":"com.webos.app.test"
}'

Response:

{
"appInfo":{
"..."
},
"appId":"com.webos.app.test",
"returnValue":true
}

getAppLifeEvents

ACG: application.operation

Added: API level 11

Description

Provides the application's event status in its life cycle.

Parameters

Name	Required	Type	Description
subscribe	Required	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribed for notifications false: Not subscribed Default: false

Name

Required

Type

Description

Required

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribed for notifications
false: Not subscribed

Default: false

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the 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 notifications. true: Subscribe for notifications false: Not subscribed
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.

Subscription 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 notifications. true: Subscribe for notifications false: Not subscribed
appId	Required	String	Indicates the appId whose event has been changed.
launchPointId	Optional	String	Indicates the launchPointId of the app.
instanceId	Optional	String	Indicates the instanceId of the app.
displayId	Optional	Number	Indicates the displayId of the app.
event	Required	String	Indicates the application's status. Possible values are: splash preload launch foreground background pause close stop
title	Optional	String	Indicates the application title as it is shown in the launcher and in the application window. Note: It is included only when event type is "splash".
showSplash	Optional	Boolean	Indicates if splash image is shown. This value is set during app scanning. Possible values are: true: Splash image is shown. false: Splash image is not shown. Note: It is included only when event type is "splash".
showSpinner	Optional	Boolean	Indicates if the spinner is shown. The value is set during app scanning. Possible values are: true: Spinner is shown. false: Spinner is not shown. Note: It is included only when event type is "splash".
splashBackground	Optional	String	Indicates the background image to be shown while the application is loading. Example: splash-background.png. Note: It is included only when the event type is "splash".
preload	Optional	Boolean	Indicates the current preload status. Possible values are: full semi-full partial minimal Note: It is included only when the event type is "preload".
reason	Optional	String	Indicates the reason behind the launching/closing of the target app. Note: It is included only when event type is "launch/close/stop".
windowType	Optional	String	Indicates the windowType of the application. Note: It is included only when event type is "foreground".
windowGroup	Optional	String	Indicates if the application has windowGroup or not. Note: It is included only when event type is "foreground".
windowGroupOwner	Optional	String	Indicates that the application has WindowGroupOwner or not. Note: It is included only when event type is "foreground".
windowGroupOwnerId	Optional	String	Indicates the windowGroupOwner of the application. Note: It is included only when event type is "foreground".
status	Optional	String	Indicates the current background status. Possible values are: preload normal Note: It is included only when event type is "background".

Example

Example : With subscription - success

# luna-send -i -f luna://com.webos.service.applicationmanager/getAppLifeEvents '{"subscribe":true}'

Response:

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

Example: Without subscription - error case

# luna-send -i -f luna://com.webos.service.applicationmanager/getAppLifeEvents '{}'

Response:

{
"subscribed":false,
"errorCode":1,
"returnValue":false,
"errorText":"subscription is required"
}

getAppLifeStatus

ACG: application.operation

Added: API level 11

Description

Provides the application's life cycle status.

Note: This API is useful to do something based on application's life cycle status.

Parameters

Name	Required	Type	Description
subscribe	Required	Boolean	Indicates if subscribed to get the notifications. Possible values are: true: Subscribe to get notifications false: Not subscribed. Default: false

Name

Required

Type

Description

Required

Boolean

Indicates if subscribed to get the notifications.

Possible values are:

true: Subscribe to get notifications
false: Not subscribed.

Default: false

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 "errorText" field for details.

subscribed

Required

Boolean

Indicates if subscribed to get the notifications.

Possible values are:

true: Subscribe to get notifications
false: Not subscribed.

errorText

Optional

String

Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

Subscription Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check "errorText" field for details.
subscribed	Required	String	Indicates if subscribed to get notifications. Possible values are: true: Subscribed for notifications false: Not subscribed
appId	Optional	String	Indicates the appId whose status has been changed.
launchPointId	Optional	String	Indicates the launchPointId of the application.
instanceId	Optional	String	Indicates the instanceId of the application.
status	Optional	String	Indicates the status of the application. Possible values are: stop launching relaunching foreground background closing
type	Optional	String	Indicates the application type. Possible values are: web native
processId	Optional	String	Indicates the processId of the application.
displayId	Optional	Number	Indicates the displayId of the application.
reason	Optional	String	In LAUNCHING/RELAUNCHING status, indicates the reason for the launching the target app. In CLOSING/STOP status, indicates the reason for closing the target app.
windowType	Optional	String	Indicates the windowType of the application. Note: This reason is replied only in FOREGROUND status.
windowGroup	Optional	Boolean	Indicates that the app has window group or not. Note: This reason is replied only in FOREGROUND status.
windowGroupOwner	Optional	Boolean	Indicates that the app is window group owner or not. Note: This reason is replied only in FOREGROUND status.
windowGroupOwnerId	Optional	String	Indicates the window group owner of the app. Note: This reason is replied only in FOREGROUND status.
backgroundStatus	Optional	String	Indicates whether the app is preloaded or not. Note: This reason is replied only in BACKGROUND status.

Error Codes Reference

Error Code	Error Text	Error Description
None	subscription is needed	"subscribe": true parameter is needed.

Example

Example: Success

AppLifeStatus can be subscribed by below command,

# luna-send -i -f luna://com.webos.service.applicationmanager/getAppLifeStatus '{
"subscribe":true
}'

Response:

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

When barenativeqt is launched, outputs are shown like below.

{
"reason":"",
"appId":"barenativeqt",
"status":"launching",
"type":"native"
}

When barenativeqt is closed, below outputs are shown.

{
"reason":"undefined",
"appId":"barenativeqt",
"status":"stop",
"processId":"932",
"type":"native"
}

getAppStatus

ACG: application.operation

Added: API level 11

Description

Gets the application status and information.

Parameters

Name	Required	Type	Description
appId	Required	String	Indicates the appld.
appInfo	Optional	Object: appInfo	Indicates the information of the application.

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.
appId	Required	String	Indicates the target appld.
event	Required	String	Indicates event according to the target app status.
status	Required	String	Indicates the current app status.
exist	Required	Boolean	Indicates if target app is present on the device. Possible values are: true: Target app exists on the device. false: Target app does not exist on the device.
launchable	Required	Boolean	Indicates whether the target app could be launched or not. Possible values are: true: Target app could be launched. false: Target app could not be launched.
appInfo	Optional	Object: appInfo	If the getAppStatus method succeeds and the parameter "appInfo" is true, the appInfo object contains information about the application.
errorCode	Optional	Number (int8_t)	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
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed.
appId	Required	String	Indicates the target appld.
event	Required	String	Indicates the event according to the target app status.
status	Required	String	Indicates the current app status.
exist	Required	Boolean	Indicates if target app is present on the device. Possible values are: true: Target app exists on the device. false: Target app does not exist on the device.
launchable	Required	Boolean	Indicates whether the target app could be launched or not. Possible values are: true: Target app could be launched. false: Target app could not be launched.
appInfo	Optional	Object array: appInfo	If the getAppStatus method succeeds and the parameter "appInfo" is true, the appInfo object contains information about the application.

Example

Example: Without appInfo

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/getAppStatus '{
"appId":"com.webos.app.browser"
}'

Response:

{
"event":"nothing",
"appId":"com.webos.app.browser",
"status":"launchable",
"exist":true,
"launchable":true,
"returnValue":true
}

Example: With appInfo

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/getAppStatus '{
"appId":"com.webos.app.browser",
"appInfo":true
}'

Response:

{
"event":"nothing",
"appInfo":{
"...." "id":"com.webos.app.browser",
"title":"Web Browser",
"...."
},
"appId":"com.webos.app.browser",
"status":"launchable",
"exist":true,
"launchable":true,
"returnValue":true
}

Example: Fail

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/getAppStatus '{
"id":"com.webos.app.browser"
}'

Response:

{
"errorCode":2,
"returnValue":false,
"errorText":"invalid parameters"
}

getForegroundAppInfo

ACG: application.operation

Added: API level 11

Description

Gets the information on the foreground application.

Note: The information comes from LSM. Please use extraInfo parameter to get raw responsePayload from LSM.

Parameters

Name	Required	Type	Description
extraInfo	Optional	Boolean	Indicates if enabled, the method returns an array of foreground applications. true: Enable. false: Disable. Default: false.
subscribe	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribed to get notifications false: Not subscribed Default: false

Name

Required

Type

Description

extraInfo

Optional

Boolean

Indicates if enabled, the method returns an array of foreground applications.

true: Enable.
false: Disable.

Default: false.

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribed to get notifications
false: Not subscribed

Default: false

Call Returns

Name	Required	Type	Description
subscribed	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribed to get notifications false: Not subscribed
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Default: true
appId	Required	String	Indicates the appId running in the foreground.
launchPointId	Optional	String	Indicates the launchPointId of the application.
instanceId	Optional	String	Indicates the instanceId of the application.
displayId	Optional	Number	Indicates the displayId of the application.
windowId	Required	String	Indicates the windowId of the application running in the foreground.
processId	Required	String	Indicates the processId of the application running in the foreground.
foregroundAppInfo	Optional	Object array: foregroundAppInfo	Indicates an array of the foreground application.

Subscription 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. Default: true
subscribed	Required	Boolean	Indicates if subscribed to get the notifications. Possible values are: true: Subscribed to get the notifications false: Not subscribed Default: true
appId	Required	String	Indicates the application ID of the application running in the foreground.
launchPointId	Optional	String	Indicates the launchPointId of the application.
instanceId	Optional	String	Indicates the instanceId of the application.
displayId	Optional	Number	Indicates the displayId of the application.
windowId	Required	String	Indicates the windowId of the application running in the foreground.
processId	Required	String	Indicates the processId of the application running in the foreground.
foregroundAppInfo	Optional	Object array: foregroundAppInfo	Indicates an array of the foreground application.

Example

Example: Without subscription

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/getForegroundAppInfo '{}'

Response:

{
"appId":"bareapp",
"returnValue":true,
"windowId":"",
"processId":""
}

Example: With subscription

# luna-send -i -f luna://com.webos.service.applicationmanager/getForegroundAppInfo '{
"subscribe":true
}'

Response:

{
"appId":"bareapp",
"subscribed":true,
"returnValue":true,
"windowId":"",
"processId":""
}

Example: With extraInfo

# luna-send -i -f luna://com.webos.service.applicationmanager/getForegroundAppInfo '{
"subscribe":true,
"extraInfo":true
}'

Response:

{
"subscribed":true,
"foregroundAppInfo":[
{
"instanceId":"c057ba89-6de6-4807-a5fe-81e8af4aac700",
"windowGroup":false,
"appId":"bareapp",
"windowType":"_WEBOS_WINDOW_TYPE_CARD",
"params":{

},
"windowId":"",
"processId":"719"
}
],
"returnValue":true
}

launch

ACG: application.launcher

Added: API level 11

Description

Launches an application corresponding to the given application ID. Opens the service or app.

Example: The user can download a content with a service in the background. Once the content is downloaded, the service must launch the app again.

Parameter can be given in the JSON object during the launch of the application. The method can be called multiple times for the same application with different parameters. Application should handle these overtime requests. Generally, application is re-launched for every request.

Note : At least one parameter is required. ('id', 'launchPointId', 'instanceId')

Parameters

Name	Required	Type	Description
id	Optional	String	Indicates the application ID to be launched.
launchPointId	Optional	String	Indicates the launch point ID of the app.
instanceId	Optional	String	Indicates the instance ID of the app.
params	Optional	Object: params	If params is used, it should contain information on the target application. Specify correct parameters for each application. See the following parameter examples: YouTube application: "params":{ "contentTarget" : "https://www.youtube.com/tv?v=9bZkp7q19f0"} Today application: "params":{"type":"showRecordedList"}
keepAlive	Optional	Boolean	Indicates the status of the application running in the background. Possible values are: true: To run the application in the background, set keepAlive to true. false: To terminate the application, set keepAlive to false. Default: keepAlive is set to false. Note: Only applicable to web app. Do not use keepAlive for native app launching. An web App, which is launched with this parameter, can be killed when memory status is low or critical.

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.
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 of this method for details.
instanceId	Optional	String	Indicates the instanceId of the running application.
launchPointId	Optional	String	Indicates the launchPointId of running application.
appId	Optional	String	Indicates the appld of the running application.
displayId	Optional	Number (uint32_t)	Indicates the displayId of the running application.

Example

Example: Launching app without parameter

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/launch '{
   "id":"com.yourdomain.callee"
}'
{
   "launchPointId": "com.yourdomain.callee_default",
   "appId": "com.yourdomain.callee",
   "returnValue": true,
   "displayId": 0,
   "instanceId": "a3effa8b-fe4a-4f5c-953b-0d326c0d2ef20"
}

Example: Launching app with parameters

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/launch '{
   "id":"com.yourdomain.callee",
   "params": {
      "customParam1": "value1"
   }
}
{
   "launchPointId": "com.yourdomain.callee_default",
   "appId": "com.yourdomain.callee",
   "returnValue": true,
   "displayId": 0,
   "instanceId": "a3effa8b-fe4a-4f5c-953b-0d326c0d2ef20"
}

listApps

ACG: application.operation

Added: API level 11

Description

Lists all of the registered applications.

Note: Client can get all installed application information using this API.

Parameters

Name	Required	Type	Description
subscribe	Optional	Boolean	Indicates if subscribe to get notifications. Possible values are: true: Subscribe for notifications false: Not subscribed Default: false
properties	Optional	String array	Indicates the value to be extracted from appinfo.json file.

Name

Required

Type

Description

Optional

Boolean

Indicates if subscribe to get notifications.

Possible values are:

true: Subscribe for notifications
false: Not subscribed

Default: false

properties

Optional

String array

Indicates the value to be extracted from appinfo.json file.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Default: true
apps	Required	Object array: appInfo	If the listApps method succeeds, the array of the applications will be returned.
subscribed	Optional	Boolean	Indicates if subscribe to get notifications. Possible values are: true: Subscribe for notifications false: Not subscribed

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

true: Indicates that the operation was successful.
false: Indicates that the operation failed.

Default: true

apps

Required

Object array: appInfo

If the listApps method succeeds, the array of the applications will be returned.

subscribed

Optional

Boolean

Indicates if subscribe to get notifications.

Possible values are:

true: Subscribe for notifications
false: Not subscribed

Subscription 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.
apps	Required	Object array: appInfo	Either this, or app is required. apps is returned when all apps' information has been changed by language change.
app	Required	Object array: appInfo	Either this, or apps is required. app is returned the information of an app which has been installed/updated/removed.
subscribed	Required	Boolean	Indicates if subscribe to get notifications. Possible values are: true: Subscribe for notifications false: Not subscribed Default: true
change	Optional	String	Indicates the reason why the app’s information has been changed. Possible values are: “added” “updated” “removed”
changeReason	Optional	String	Indicates the reason behind the target app being added/removed.

Example

Example: Success

This method returns information for all apps at first.

# luna-send -i -f luna://com.webos.service.applicationmanager/listApps '{
"subscribe":true
}'

Response:

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

When an app is update/removed/installed, the method returns only changed app's information

{
"subscribed":true,
"change":"removed",
"returnValue":true,
"app":{
"..."
}
}

listLaunchPoints

ACG: application.operation

Added: API level 11

Description

Gets all of the launchpoints.

Note: LaunchPoint is the virtual instance of an application. The webOS provides shortcut based on launchPoint.

Parameters

Name	Required	Type	Description
subscribe	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribed for notifications false: Not subscribed Default: false

Name

Required

Type

Description

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribed for notifications
false: Not subscribed

Default: false

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. Note: returnValue will always contain true.
subscribed	Required	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribed for notifications false: Not subscribed
launchPoints	Required	Object array: launchPoints	If the listLaunchPoints method succeeds, the array of the launchpoints will be returned.

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.

Note: returnValue will always contain true.

subscribed

Required

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribed for notifications
false: Not subscribed

launchPoints

Required

Object array: launchPoints

If the listLaunchPoints method succeeds, the array of the launchpoints will be returned.

Subscription Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the 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	String	Indicates if subscribed to get the notifications. Possible values are: true: Subscribed for notifications false: Not subscribed Default: true
launchPoint	Optional	Object	Returned if only one app's launchPoint is changed by updating/removing/installing.
change	Optional	String	Indicates the change in the status of the launch point. Possible values are: added updated removed
favicon	Optional	String	Favorite icon image displayed for the website.

Example

Example code

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/listLaunchPoints '{
"subscribe":true
}'

Response:

{
   "subscribed":true,
   "launchPoints":[
      {
         "id":"bareapp",
         "..."
      },
      "..."
   ],
   "returnValue":true
}

lockApp

ACG: application.launcher

Added: API level 11

Description

Locks an application.

Note:

Once it is locked, the application cannot be launched.
This method is only called by appinstalld. Do not use this method in your application.

Parameters

Name

Required

Type

Description

Required

String

The application ID to be locked.

lock

Required

Boolean

Indicates if the application is locked.

Possible values are:

true: The application is locked, set lock to true. If set to true, the application cannot be launched.
false: The application is unlocked.

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 "errorText" field for details.
locked	Required	Boolean	Indicates if the application is locked or unlocked. Possible values are: true: The application is locked false: The application is unlocked
id	Required	String	Indicates the application ID which is locked or unlocked.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

Error Codes Reference

Error Code	Error Text	Error Description
None	Missing required key	Missing required key.
None	Parameters 'id'(string) or 'lock'(bool) is missing	Parameters 'id'(string) or 'lock'(bool) is missing.
None	was not found OR Unsupported Application Type	Was not found or an unsupported application type.

Example

None

pause

ACG: application.launcher

Added: API level 11

Description

Pauses an application.

Note: At least one parameter is required. ('id', 'launchPointId', 'instanceId')

Parameters

Name	Required	Type	Description
id	Optional	String	Indicates the id of the application.
launchPointId	Optional	String	Indicates the launchPointId of the application.
instanceId	Optional	String	Indicates the instanceId of the application.
params	Optional	Object	If params is used, it should contain information on the target application.

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.
errorCode	Optional	Number (int8_t)	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.
instanceId	Optional	String	Indicates the instanceId of the running application.
launchPointId	Optional	String	Indicates the launchPointId of the running application.
appId	Optional	String	Indicates the appId of the running application.
displayId	Optional	Number (int32_t)	Indicates the displayId of the running application.

Example

Example code

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/pause '{
"id":"com.webos.app.test"
}'

Response:

{
"returnValue":true
}

registerApp

ACG: application.operation

Added: API level 11

Description

Registers to receive events related to app life cycle.

Parameters

None

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

true: Indicates that the operation was successful.
false: Indicates that the operation failed.

event

Required

String

Indicates the event that is triggered.

Possible values are:

registered: Triggered when an app is registered. This event is not an official app life cycle event.
relaunch: Triggered when an already registered application is launched.
pause: Triggered when transitioning the foreground app to the background. The close event is delivered only when memory manager terminates.
close: Triggered when the registered application is closed.

Subscription Returns

Name	Required	Type	Description
event	Required	String	It indicates one of events the app should handle.
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed.
parameters	Optional	Object: params	Indicates the information to be delivered to the registered app.
reason	Optional	String	Indicates the reason for the app to be launched/closed.
appId	Optional	String	Indicates the ID of the registered app.

Example

Example code

# luna-send -a com.webos.app.home -i -f luna://com.webos.service.applicationmanager/registerApp '{}'

Response:
{
"event": "registered",
"returnValue": true,
"message": "registered"
}
{
"event": "relaunch",
"returnValue": true,
"appId": "com.webos.app.home",
"message": "relaunch",
"parameters": {
"displayId": 0,
"displayAffinity": 0
},
"reason": "com.webos.lunasend-4147"
}
{
"event": "pause",
"returnValue": true,
"appId": "com.webos.app.home",
"message": "pause",
"parameters": {
"displayId": 0,
"displayAffinity": 0
},
"reason": "com.webos.lunasend-4154"
}
{
"event": "close",
"returnValue": true,
"appId": "com.webos.app.home",
"message": "close",
"parameters": {
"displayId": 0,
"displayAffinity": 0
},
"reason": "com.webos.lunasend-4183"
}

removeLaunchPoint

ACG: application.launcher

Added: API level 11

Description

Removes a dynamic launchpoint.

Note: It can cause application uninstall.

Parameters

Name	Required	Type	Description
launchPointId	Required	String	Indicates the launchpoint ID to be removed.

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the 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.

errorCode

Optional

Number (int8_t)

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 more details.

Error Codes Reference

Error Code	Error Text	Error Description
None	invalid json request	Invalid JSON request.
None	cannot find launch point info	Cannot find launch point information for launchPointId.

Example

Example: With launchPointid

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/removeLaunchPoint '{
"launchPointId":"178884"
}'

Response:

{
"returnValue":true
}

running

ACG: application.launcher

Added: API level 11

Description

Lists the background/foreground applications and their process IDs that are running on webOS platform.

Note: This API is one of key methods of applicationmanager.

Parameters

Name

Required

Type

Description

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe to get notifications
false: Not subscribed

Default: false

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

true: Indicates that the operation was successful.
false: Indicates that the operation failed.

Default: true

subscribed

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe to get notifications
false: Not subscribed

running

Required

Object array: running

If the running method succeeds, the array of the running applications will be returned.

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

Default: true

subscribed

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe to get notifications
false: Not subscribed

running

Required

Object array: running

If the running method succeeds, the array of the running applications will be returned.

Example

Example: Success

# luna-send -i -f luna://com.webos.service.applicationmanager/running '{
"subscribe":true
}'

Response:

{
"subscribed":true,
"running":[
{
"id":"bareapp",
"..."
}
],
"returnValue":true
}

updateLaunchPoint

ACG: application.launcher

Added: API level 11

Description

Updates a dynamic launchpoint.

Note: If a user changes the HDMI application icon to another icon like a game icon using Input Manager on a TV, the HDMI application icon is dynamically
changed to the new icon on the launcher.

Parameters

Name

Required

Type

Description

launchPointId

Required

String

Indicates the launchpoint ID to be updated.

Note: Both launchPointId and one or more parameters (title, icon, etc) need to be passed from service user.

title

Optional

String

Indicates the launchpoint title.

icon

Optional

String

Indicates the path of the icon image displayed for the launchpoint.

bgImage

Optional

String

Indicates the path of the background image displayed to the user when the user hovers over the launchpoint.

Format: color hex code (ex. #000000(black))

http://www.color-hex.com/

bgColor

Optional

String

Indicates the background color for the launchpoint. It will be displayed when the bgImage is not provided or unable to display. A color can be specified as a hex value or as a HTML color name.

imageForRecents

Optional

String

Indicates the path of the image displayed in the Recents tile.

iconColor

Optional

String

Indicates the background color for the application tile. The application tile is displayed in the Home, the Launcher, and the Recent screen.

Format: color hex code (ex. #000000(black))

http://www.color-hex.com/

largeIcon

Optional

String

Indicates the path of the large icon (130x130 pixels) displayed in the top left corner of the screen, when the user hovers over an application tile in the Launcher.

Note: This file path is relative to the appinfo.json file.

appDescription

Optional

String

Indicates a brief description for the launchpoint.

Note: The appDescription cannot exceed 60 characters.

params

Optional

Object: params

If params is used, it should contain information on the launchpoint which will be passed to the application.

bgImages

Optional

String array

Indicates the paths of the background images displayed to the user when the user hovers over the launchpoint.

tileSize

Optional

String

Indicates the tile size on UI.

Possible values are

normal
large.

Default: normal

Note:

The large tile hints that UI should make this tile larger than normal (2x).
Usually, large size may be used for promotional application.

unmovable

Optional

Boolean

Indicates if the launchpoint position is movable or not.

Possible values are:

true: The launchpoint position cannot be moved by the user.
false: the launchpoint position can be moved by the user.

Default: false

userData

Optional

String

Indicates the additional data that may be used for analytical purposes.

Note: The userData will simply be logged when the user interacts with it in Launcher.

icons

Optional

Object array

Indicates the list of icon images.

Note: The icons will be shown in the launch point alternately.

favicon

Optional

String

Indicates the favorite icon image displayed for the website.

policyCategory

Optional

String

Indicate a category(group) of the launch point. The value should be the one of below mapping table.

*$RESERVED_VALUE is for special callers to be controlled by LPM.

Value	Launch Point Type	position
default	Any	9
*$RESERVED_VALUE	$RESERVED_LP	$RESERVED_POSITION

relaunch

Optional

Boolean

Indicates if the target app is re-launched whenever the launch point is clicked. (Not fast-switching)

Note: This parameter is deprecated in IvyLeague.

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the 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.

errorCode

Optional

Number (int8_t)

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 more details.

Error Codes Reference

Error Code	Error Text	Error Description
None	invalid json request	Invalid JSON request.
None	cannot find launch point info	Cannot find launch point information for launchPointId.

Example

Example: With launchPointId and title

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/updateLaunchPoint '{
"launchPointId":"178884",
"title":"Test"
}'

Response:

{
"returnValue":true
}

Example: Insufficient parameters

# luna-send -n 1 -f luna://com.webos.service.applicationmanager/updateLaunchPoint '{
"launchPointId":"178884"
}'

Response:

{
"returnValue":false,
"errorText":"Insufficient parameters"
}

Objects

appInfo

Contains the information about the application.

Name	Required	Type	Description
id	Required	String	Indicates the application ID. Example: \"com.newco.app.myApp\" Note: Every application has a unique ID, created from reverse DNS naming conventions. The launcher uses the ID to uniquely identify application and displays it with the title above. The application ID is unique,can only be set once, and cannot be changed after publishing the application.
main	Required	String	Indicates the launchpoint of the application. Note: This is a file path relative to the appinfo.json file and needs to point to an HTML file.
title	Required	String	Indicates the application title as it is shown in the launcher and in the application window. Note: The application title is unique, set once.
icon	Required	String	Indicates the path of the icon image displayed for the application. Note: The file path is relative to the appinfo.json file. The default is \"icon.png\"
largeIcon	Optional	String	The path of the large icon (130x130 pixels) displayed in the top left corner of the screen, when the user hovers over an application tile in the Launcher. This file path is relative to the appinfo.json file.
type	Required	String	The application type; web or pdk.
splashBackground	Optional	String	The background image to be shown while application is loading, e.g., splash-background.png.
vendor	Optional	String	The application owner used in the launcher and deviceinfo dialogs.
transparent	Optional	Boolean	This indicates whether the web application's background is transparent or not.
version	Optional	String	The application version number, in the dot-notation format, e.g., 3.0.2500.
handlesRelaunch	Optional	Boolean	This indicates whether the application is relaunched or not when a user executes application that is already running.
requiredMemory	Optional	Number (int8_t)	The memory consumption is increasing quickly while launching. OOM can occur before system (Memory Manager) try to acquire adequate memory for the application. The requiredMemory describes the maximum usage of memory, in megabytes, while an application is launching. This is not same as the maximum memory usage while the application is running.
iconColor	Optional	String	The background color for the application tile. The application tile is displayed in the Home, the Launcher, and the Recent screen.
appDescription	Optional	String	A short description for the application. The appDescription cannot exceed 60 characters.

foregroundAppInfo

The object contains sorted foreground applications in ascending order.

Name	Required	Type	Description
instanceId	Optional	String	InstanceId of running application.
appId	Required	String	The application ID.
windowId	Required	String	The window ID of the application running in the foreground.
processId	Required	String	The process ID of the application running in the foreground.
displayId	Optional	Number	The display ID of application.

launchPoints

Contains the array of launchpoints.

Name	Required	Type	Description
lptype	Required	String	The launchpoint type: default, bookmark, group.
id	Required	String	The application ID of the launchpoint.
launchPointId	Required	String	The unique launchpoint ID.
removable	Required	Boolean	This indicates whether the application is removable or not.
title	Required	String	The application title as it is shown in the Launcher and in the application window. The application title is unique, set once.
icon	Required	String	The image displayed for the application.
iconColor	Required	String	The background color for the application tile. The application tile is displayed in the Home, the Launcher, and the Recent screen.
largeIcon	Required	String	The path of the large icon (130x130 pixels) displayed in the top left corner of the screen, when the user hovers over an application tile in the Launcher. This file path is relative to the appinfo.json file.
appDescription	Required	String	A short description for the application. The appDescription cannot exceed 60 characters.
params	Optional	Object: params	The params object contains information on the target application. You should specify correct parameters for each application.
userData	Optional	String	The additional data that may be used for analytical purposes. The userData will simply be logged when the user interacts with it in Launcher.

params

Contains the parameters for the target application. Specify correct parameters for each application. As each application has different parameters, the parameters of params cannot be defined.

running

Indicates the object that contains the array of the running applications.

Name	Required	Type	Description
id	Required	String	The application ID.
launchPointId	Optional	String	The launch point ID of the app.
instanceId	Optional	String	The instance ID of the app.
displayId	Optional	Number	The display ID of the app.
processId	Required	String	The process ID of the application.
webprocessid	Required	String	The webprocess ID of the application.
defaultWindowType	Required	String	The default window type of the application. Used by WAM (WebAppMgr) to launch a window with a special window type setting. The value will be one of the followings: card minimal overlay popup
appType	Required	String	The application type.

API Error Codes Reference

Error Code	Error Text	Error Description
None	Missing required key	Missing required key.
None	invalid json request	Invalid JSON request.
-312	not allowed	EULA is not accepted.
-203	[ID] is already launching	The native application is already launching.
-102	[ID] has been locked.	Application has been locked.