com.webos.service.webappmanager

API Summary

Internal system service for handling web-based (HTML) applications.

The Web App Manager (WAM) is a component responsible for web application management in webOS platform. The Application Manager (SAM) sends a request to manage web applications to WAM.

WAM handles basic routines such as launching, closing apps as well as the following features of web applications.

Running lists
Life cycles
Current status of applications
Application crash

Overview of the API

Methods

closeAllApps

Description

Close all currently running applications.

Parameters

None

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.

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.

Example

# luna-send -n 1 luna://com.webos.service.webappmanager/closeAllApps '{}'

closeByProcessId

Description

Close an application using the internal associated processId.

Parameters

Name	Required	Type	Description
processId	Required	String	The id of process to close.

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.
appId	Optional	string	The id of closed app.
processId	Optional	String	The id of closed process.
errorText	Optional	string	Indicates the reason for the failure of the operation.

Example

# luna-send -n 1 luna://com.webos.service.webappmanager/closeByProcessId '{"processId":"1008"}'

Returns:

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

getWebProcessSize

Description

Get the size of current running WebProcess.

Parameters

None

Call Returns

Name	Required	Type	Description
WebProcesses	Required	Object array: WebProcesses	List of apps which the process is running.
returnValue	Required	Boolean	returnValue will contain true.

Example

# luna-send -n 1 luna://com.webos.service.webappmanager/getWebProcessSize '{}'

Returns:

{
   "WebProcesses":[
      {
         "pid":"4252",
         "runningApps":[
            {
               "id":"bareapp"
            }
         ],
         "tileSize":0,
         "webProcessSize":"77632 kB"
      },
   "returnValue":true
}

killApp

Description

Kill all windows owned by the specified app. This is intended to be used by SAM if necessary.

Parameters

Name	Required	Type	Description
appId	Required	string	The ID of app to kill.

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.

errorText

Optional

string

Indicates the reason for the failure of the operation.

appId

Optional

string

The ID of the killed app.

Example

# luna-send -n 1 luna://com.webos.service.webappmanager/killApp '{"appId":"bareapp"}'

Returns:

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

launchApp

Description

Launch an application by app ID. This is the major function used by SAM to request launching an application.

Parameters

Name	Required	Type	Description
appDesc	Required	string	JSON object containing the appinfo.json parameters determined by SAM.
parameters	Optional	string	JSON object containing the parameters to pass to the app.
launchingAppId	Optional	string	The ID of the launching app.
launchingProcId	Optional	number	The ID of the process launching the app.

Call Returns

Name	Required	Type	Description
appId	Required	string	The ID of the launched app. The app is launched according to the properties specified in the appDesc parameter.
procId	Required	number	The ID of the process assigned to this launch.
errorText	Optional	string	Indicates the reason for the failure of the operation.
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed.

Example

# luna-send -n 1 luna://com.webos.service.webappmanager/launchApp '{
"launchingAppId":"com.webos.app.home",
"appDesc":{
"defaultWindowType":"card",
"uiRevision":"2",
"systemApp":true,
"version":"1.0.1",
"vendor":"LG Electronics, Inc.",
"miniicon":"icon.png",
"hasPromotion":false,
"tileSize":"normal",
"icons":[

],
"launchPointId":"bareapp_default",
"largeIcon":"/usr/palm/applications/bareapp/icon.png",
"lockable":true,
"transparent":false,
"icon":"/usr/palm/applications/bareapp/icon.png",
"checkUpdateOnLaunch":true,
"imageForRecents":"",
"spinnerOnLaunch":true,
"handlesRelaunch":false,
"unmovable":false,
"id":"bareapp",
"inspectable":false,
"noSplashOnLaunch":false,
"privilegedJail":false,
"trustLevel":"default",
"title":"Bare App",
"deeplinkingParams":"",
"lptype":"default",
"inAppSetting":false,
"favicon":"",
"visible":true,
"accessibility":{
"supportsAudioGuidance":false
},
"folderPath":"/usr/palm/applications/bareapp",
"main":"index.html",
"removable":true,
"type":"web",
"disableBackHistoryAPI":false,
"bgImage":""
},
"appId":"bareapp",
"parameters":{
"displayAffinity":0
},
"reason":"com.webos.app.home",
"launchingProcId":"",
"instanceId":"c395796b-03fa-4d63-9bd8-891da54305490"
}'

Returns:

{
"appId": "bareapp",
"procId": "1004",
"returnValue": true
}

listRunningApps

Description

Return a list of applications that Web App Manager is running. This method can be subscribed.

Parameters

Name	Required	Type	Description
subscribe	Optional	boolean	Subscribe for notifications. Possible values are: true - Get notifications false - Notifications are not required Default value: false
includeSysApps	Optional	boolean	Includes/excludes system applications in the running app list.Possible values are: true: To include system applications in the running app list. false: To exclude system applications from the running app list. Default value: false.

Name

Required

Type

Description

Optional

boolean

Subscribe for notifications. Possible values are:

true - Get notifications
false - Notifications are not required

Default value: false

includeSysApps

Optional

boolean

Includes/excludes system applications in the running app list.Possible values are:

true: To include system applications in the running app list.
false: To exclude system applications from the running app list.

Default value: false.

Call Returns

Name	Required	Type	Description
running	Required	String array	Array of all running apps. Each app will be returned in the form of {"id": appId, "processId": processId, "webprocessid": weprocessid}.
returnValue	Required	boolean	returnValue will always contain true.

Subscription Returns

Name

Required

Type

Description

running

Required

String array

Array of all running apps. Each app will be returned in the form of {"id": appId, "processId": processId, "webprocessid": weprocessid}.

returnValue

Required

Boolean

returnValue will always contain true.

subscribed

Required

Boolean

Indicates if subscribed.

true - Subscribed for changes
false - Not subscribed

Example

Example 1:

# luna-send -n 1 luna://com.webos.service.webappmanager/listRunningApps '{}'

Returns:

{
   "returnValue":true,
   "running":[
      {
         "id":"bareapp",
         "processid":"1008",
         "webprocessid":"4294"
      }
   ]
}

Example 2:

# luna-send -n 1 luna://com.webos.service.webappmanager/listRunningApps '{"includeSysApps":true}'

Returns:

{
   "returnValue":true,
   "running":[
{
         "id":"bareapp",
         "processid":"1008",
         "webprocessid":"4294"
      }
   ]
}

Example 3:

# luna-send -n 1 luna://com.webos.service.webappmanager/listRunningApps '{"subscribe":true}'

Returns:

{
   "returnValue":true,
   "running":[
      {
         "id":"bareapp",
         "processid":"1002",
         "webprocessid":"2618"
      }
   ],
   "subscribed":true
}

logControl

Description

Enable or disable whether to show logs with associated keys.

Parameters

Name	Required	Type	Description
keys	Required	String	Keys to determine which log to enable. This parameter will be ignored if it doesn't match with existing keys.
value	Required	String	To show log of specified key, set value to "on". To hide log of specified key, set value to "off". The value will be ignored when it is not "on" or "off".

Name

Required

Type

Description

keys

Required

String

Keys to determine which log to enable. This parameter will be ignored if it doesn't match with existing keys.

value

Required

String

To show log of specified key, set value to "on".

To hide log of specified key, set value to "off".

The value will be ignored when it is not "on" or "off".

Call Returns

Name	Required	Type	Description
event	Required	Boolean	Indicates whether event logs are shown or not. Possible values are: true: If enabled to show event logs. false: If disabled to show event logs.
bundleMessage	Required	Boolean	Indicates whether bundleMessage logs are shown or not. true: If enabled showing bundleMessage logs. false: If disabled showing bundleMessage logs.
mouseMove	Required	Boolean	Indicates whether mouseMove logs are shown or not. true: If enabled showing mouseMove logs. false: If disabled showing mouseMove logs.
returnValue	Optional	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed.

Example

# luna-send -n 1 luna://com.webos.service.webappmanager/logControl '{"keys":"event","value":"on"}'

Returns:

{
"bundleMessage":false,
"event":true,
"mouseMove":false
}

webProcessCreated

Description

Return the process ID of the launched application. This method can be subscribed.

Parameters

Name	Required	Type	Description
appId	Required	String	The ID of the launched application.
subscribe	Optional	Boolean	Subscribe for notifications. Possible values are: true - Get notifications false - Notifications are not required Default value: false

Name

Required

Type

Description

appId

Required

String

The ID of the launched application.

Optional

Boolean

Subscribe for notifications. Possible values are:

true - Get notifications
false - Notifications are not required

Default value: false

Call Returns

Name	Required	Type	Description
id	Optional	String	The ID of the launched application.
errorText	Optional	String	Indicates the reason for the failure of the operation.
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed.
webprocessid	Optional	Number	The process ID of the launched application.

Subscription Returns

Name

Required

Type

Description

Optional

String

The ID of the launched application.

returnValue

Required

Boolean

Indicates the status of operation. Possible values are:

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

subscribed

Optional

Boolean

Indicates if subscribed to get notified.

true - Subscribed for changes
false - Not subscribed

Example

# luna-send -n 1 luna://com.webos.service.webappmanager/webProcessCreated '{"appId":"bareapp"}'

Returns:

{
   "id":"bareapp",
   "returnValue":true,
   "webprocessid":4865
}

clearBrowsingData

Description

Clears browsing data of a specific type.

Parameters

Name	Required	Type	Description
types	Optional	String array	Type of browsing data to be deleted. Possible values are: all (includes browsing data of all other specified types) appcache cache codecache cookies fileSystems localStorage channelIDs serviceWorkers cacheStorage webSQL Note: If no value is provided, by default, the method deletes all browsing data.

Name

Required

Type

Description

types

Optional

String array

Type of browsing data to be deleted. Possible values are:

all (includes browsing data of all other specified types)
appcache
cache
codecache
cookies
fileSystems
localStorage
channelIDs
serviceWorkers
cacheStorage
webSQL

Note: If no value is provided, by default, the method deletes all browsing data.

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 "Error Codes Reference" section of this method for details.

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 "Error Codes Reference" section of this method for details.

Error Codes Reference

Error Code	Error Text	Error Description
3000	Empty array is not allowed.	Occurs because value of array type for "types" parameter is not specified. It means that the array is defined but the length is 0.
3001	Invalid value (Only allowed for string type)	Occurs because data type of "types" parameter is wrong. Only string array is possible.
3002	Unknown data: [wrong value]	Occurs because value of 'types' parameter is unknown data. Refer to possible values specified in the parameter section.

Example

- Using the "all" value for the "types" parameter

# luna-send -n 1 luna://com.webos.service.webappmanager/clearBrowsingData '{"types":["all"]}'

- Without specifying the "types" parameter

# luna-send -n 1 luna://com.webos.service.webappmanager/clearBrowsingData '{}'

- Clears localstorage type browsing data

# luna-send -n 1 luna://com.webos.service.webappmanager/clearBrowsingData '{"types":["localStorage"]}'

- Clears localstorage and cache types of browsing data

# luna-send -n 1 luna://com.webos.service.webappmanager/clearBrowsingData '{"types":["cache", "localStorage"]}'

pauseApp

Note
This method is available since webOS OSE 2.4.0.

Description

Pauses a web application.

This method can be used by SAM to move a specified web application from foreground to background (currently, SAM uses the keep-alive feature instead of WAM).

Parameters

Name	Required	Type	Description
appId	Required	String	The ID of the app to be paused.

Call Returns

Name	Required	Type	Description
appId	Optional	String	The ID of the app that is paused.
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation.

Example

# luna-send -n 1 luna://com.webos.service.webappmanager/pauseApp '{"appId":"bareapp"}'

Returns:

{
"bareapp",
"returnValue":true
}

Objects

WebProcesses

Contains the size of current running WebProcess.

Name	Required	Type	Description
pid	Optional	String	The ID of the process.
webProcessSize	Optional	String	The size of the process in KB.
tileSize	Optional	Number	The size of the tile in KB.
runningApps	Optional	String array	List of apps which the process is running.