com.webos.service.applicationmanager

API Summary

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

Overview of the API

NA

    Methods

    launch

    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

    idOptionalString

    Indicates the application ID to be launched.

    launchPointIdOptionalString

    Indicates the launch point ID of the app.

    instanceIdOptionalString

    Indicates the instance ID of the app.

    paramsOptionalObject: 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"}
    keepAliveOptionalBoolean

    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

    returnValueRequiredBoolean

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

    The error code for the failed operation.

    errorTextOptionalString

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

    instanceIdOptionalString

    Indicates the instanceId of the running application.

    launchPointIdOptionalString

    Indicates the launchPointId of running application.

    appIdOptionalString

    Indicates the appld of the running application.

    displayIdOptionalNumber (uint32_t)

    Indicates the displayId of the running application.

    Example

    # 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"
    }

    # 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"
    }

    pause

    Description

    Pauses an application.

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

    Parameters

    Name

    Required

    Type

    Description

    idOptionalString

    Indicates the id of the application.

    launchPointIdOptionalString

    Indicates the launchPointId of the application.

    instanceIdOptionalString

    Indicates the instanceId of the application.

    paramsOptionalObject

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

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    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.
    errorCodeOptionalNumber (int8_t)

    The error code for the failed operation.

    errorTextOptionalString

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    instanceIdOptionalString

    Indicates the instanceId of the running application.

    launchPointIdOptionalString

    Indicates the launchPointId of the running application.

    appIdOptionalString

    Indicates the appId of the running application.

    displayIdOptionalNumber (int32_t)

    Indicates the displayId of the running application.

    Example

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

    Response:

    {
       "returnValue":true
    }

    close

    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

    idOptionalString

    Indicates the id of the application.

    launchPointIdOptionalString

    Indicates the launchPointId of the application.

    instanceIdOptionalString

    Indicates the instanceId of the application.

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

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

    errorCodeOptionalNumber

    The error code for the failed operation.

    processIdOptionalString

    Indicates the processId of the closed application.

    instanceIdOptionalString

    Indicates the instanceId of the running application.

    launchPointIdOptionalString

    Indicates the launchPointId of the running application.

    appIdOptionalString

    Indicates the appId of the running application.

    displayIdOptionalNumber (int32_t)

    Indicates the displayId of running application.

    Error Codes Reference

    Error Code

    Error Text

    Error Description

    NoneInvalid processId specified

    Invalid processId is specified.

    NoneNot string

    Invalid type value.

    NoneUnknown Process

    Unknown processId.

    Example

    # 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

    Description

    Closes an application by appId in the system manager.

    Parameters

    Name

    Required

    Type

    Description

    idOptionalString

    Indicates the id of the application.

    reasonOptionalString

    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

    returnValueRequiredBoolean

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

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

    instanceIdOptionalString

    Indicates the instanceId of the running application.

    launchPointIdOptionalString

    Indicates the launchPointId of the running application.

    displayIdOptionalString

    Indicates the displayId of the running application.

    Error Codes Reference

    Error Code

    Error Text

    Error Description

    Noneinvalid parameter

    invalid parameter.

    Noneno app description

    Invalid appId is specified. That is, the 'id' parameter is empty.

    NoneNot string

    Invalid type value.

    Noneapp is not running

    Application is not running.

    Example

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

    listApps

    Description

    Lists all of the registered applications.

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

    Parameters

    Name

    Required

    Type

    Description

    subscribeOptionalBoolean

    Indicates if subscribe to get notifications.

    Possible values are:

    • true: Subscribe for notifications
    • false: Not subscribed

    ​​Default: false

    propertiesOptionalString array

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

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    Indicates the status of the operation.

    Possible values are:

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

    Default: true

    appsRequiredObject array: appInfo

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

    subscribedOptionalBoolean

    Indicates if subscribe to get notifications.

    Possible values are:

    • true: Subscribe for notifications
    • false: Not subscribed

    Subscription Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    Indicates the status of operation.

    Possible values are:

    • true: Indicates that the operation was successful.
    • false: Indicates that the operation failed.
    appsRequiredObject array: appInfo

    Either this, or app is required.

    apps is returned when all apps' information has been changed by language change.

    appRequiredObject array: appInfo

    Either this, or apps is required.

    app is returned the information of an app which has been installed/updated/removed.

    subscribedRequiredBoolean

    Indicates if subscribe to get notifications.

    Possible values are:

    • true: Subscribe for notifications
    • false: Not subscribed

    Default: true

    changeOptionalString

    Indicates the reason why the app’s information has been changed.

    Possible values are:

    • “added”
    • “updated”
    • “removed”
    changeReasonOptionalString

    Indicates the reason behind the target app being added/removed.

    Example

    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":{
          "..."
       }
    }

    running

    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

    subscribeOptionalBoolean

    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

    returnValueRequiredBoolean

    Indicates the status of the operation.

    Possible values are:

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

    Default: true

    subscribedOptionalBoolean

    Indicates if subscribed to get notifications. 

    Possible values are:

    • true: Subscribe to get notifications
    • false: Not subscribed
    runningRequiredObject array: running

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

    Subscription Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    Indicates the status of operation.

    Possible values are:

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

    Default: true

    subscribedOptionalBoolean

    Indicates if subscribed to get notifications. 

    Possible values are:

    • true: Subscribe to get notifications
    • false: Not subscribed
    runningRequiredObject array: running

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

    Example

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

    Response: 

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

    dev/closeByAppId

    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

    idRequiredString

    Indicates the application id to be closed.

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

    Indicates the instanceId of running application.

    launchPointIdOptionalString

    Indicates the launchPointId of running application.

    displayIdOptionalNumber (int32_t)

    Indicates the displayId of the running application.

    Error Codes Reference

    Error Code

    Error Text

    Error Description

    Noneapp is not running

    The application that you want to close is not running.

    Noneno app description

    Passed id is invalid. That is, id parameter is empty.

    NoneNot string

    Passed value is an invalid type.

    Noneinvalid parameter

    Passed parameter is invalid.

    NoneOnly Dev app should be closed using /dev category_API

    In devmode, an application must be closed by dev/closeByAppId method.

    Example

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

    dev/listApps

    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

    subscribeOptionalString

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribe to get notifications
    • false: Do not subscribe

    Default: false

    propertiesOptionalString array

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

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribed to get notifications
    • false: Not subscribed
    appsRequiredObject array: appInfo

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

    Subscription Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    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.
    appsRequiredObject array: appInfo

    Either this, or app will be returned.

    apps is returned when all apps' information has been changed by language change.

    appRequiredObject array: appInfo

    Either this, or apps will be required.

    app is returned the information of an app which has been installed/updated/removed.

    subscribedRequiredBoolean

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribed to get notifications
    • false: Not subscribed

    Default: true

    changeOptionalString

    Indicates the reason for the change in the app information.

    Possible values are:

    • added
    • updated
    • removed
    changeReasonOptionalString

    Indicates the reason why the target app is added/removed.

    Example

    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/running

    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

    subscribeOptionalBoolean

    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

    returnValueRequiredBoolean

    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.

    subscribedOptionalBoolean

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribe to get notifications
    • false: Not subscribed
    runningRequiredObject array: running

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

    Subscription Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    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.

    subscribedOptionalBoolean

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribe to get notifications
    • false: Not subscribed
    runningRequiredObject array: running

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

    Example

    # 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
    }

    getForegroundAppInfo

    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

    extraInfoOptionalBoolean

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

    • true: Enable.
    • false: Disable.

    Default: false.

    subscribeOptionalBoolean

    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

    returnValueRequiredBoolean

    Indicates the status of the operation.

    Possible values are:

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

    Default: true

    subscribedOptionalBoolean

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribed to get notifications
    • false: Not subscribed
    appIdRequiredString

    Indicates the appId running in the foreground.

    launchPointIdOptionalString

    Indicates the launchPointId of the application.

    instanceIdOptionalString

    Indicates the instanceId of the application.

    displayIdOptionalNumber

    Indicates the displayId of the application.

    windowIdRequiredString

    Indicates the windowId of the application running in the foreground. 

    processIdRequiredString

    Indicates the processId of the application running in the foreground.

    foregroundAppInfoOptionalObject array: foregroundAppInfo

    Indicates an array of the foreground application.

    Subscription Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    Indicates the status of operation.

    Possible values are:

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

    Default: true

    subscribedRequiredBoolean

    Indicates if subscribed to get the notifications.

    Possible values are:

    • true: Subscribed to get the notifications
    • false: Not subscribed

    Default: true

    appIdRequiredString

    Indicates the application ID of the application running in the foreground.

    launchPointIdOptionalString

    Indicates the launchPointId of the application.

    instanceIdOptionalString

    Indicates the instanceId of the application.

    displayIdOptionalNumber

    Indicates the displayId of the application.

    windowIdRequiredString

    Indicates the windowId of the application running in the foreground. 

    processIdRequiredString

    Indicates the processId of the application running in the foreground.

    foregroundAppInfoOptionalObject array: foregroundAppInfo

    Indicates an array of the foreground application.

    Example

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

    Response:

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

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

    Response:

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

    # 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
    }

    getAppLifeStatus

    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

    subscribeRequiredBoolean

    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

    returnValueRequiredBoolean

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

    Indicates if subscribed to get the notifications.

    Possible values are:

    • true: Subscribe to get notifications
    • false: Not subscribed.
    errorTextOptionalString

    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

    returnValueRequiredBoolean

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

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribed for notifications
    • false: Not subscribed
    appIdOptionalString

    Indicates the appId whose status has been changed.

    launchPointIdOptionalString

    Indicates the launchPointId of the application.

    instanceIdOptionalString

    Indicates the instanceId of the application.

    statusOptionalString

    Indicates the status of the application.

    Possible values are:

    • stop
    • launching
    • relaunching
    • foreground
    • background
    • closing
    typeOptionalString

    Indicates the application type.

    Possible values are:

    • web
    • native
    processIdOptionalString

    Indicates the processId of the application.

    displayIdOptionalNumber

    Indicates the displayId of the application.

    reasonOptionalString

    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.

    windowTypeOptionalString

    Indicates the windowType of the application.

    Note: This reason is replied only in FOREGROUND status.

    windowGroupOptionalBoolean

    Indicates that the app has window group or not.

    Note: This reason is replied only in FOREGROUND status.

    windowGroupOwnerOptionalBoolean

    Indicates that the app is window group owner or not.

    Note: This reason is replied only in FOREGROUND status.

    windowGroupOwnerIdOptionalString

    Indicates the window group owner of the app.

    Note: This reason is replied only in FOREGROUND status.

    backgroundStatusOptionalString

    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

    Nonesubscription is needed

    "subscribe": true parameter is needed.

    Example

    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"
    }

    getAppLifeEvents

    Description

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

    Parameters

    Name

    Required

    Type

    Description

    subscribeRequiredBoolean

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribed for notifications
    • false: Not subscribed

    ​Default: false

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

    Indicates if subscribed to get notifications.

    • true: Subscribe for notifications
    • false: Not subscribed
    errorTextOptionalString

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    errorCodeOptionalNumber (int8_t)

    The error code for the failed operation.

    Subscription Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

    Indicates if subscribed to get notifications.

    • true: Subscribe for notifications
    • false: Not subscribed
    appIdRequiredString

    Indicates the appId whose event has been changed.

    launchPointIdOptionalString

    Indicates the launchPointId of the app.

    instanceIdOptionalString

    Indicates the instanceId of the app.

    displayIdOptionalNumber

    Indicates the displayId of the app.

    eventRequiredString

    Indicates the application's status.

    Possible values are:

    • splash
    • preload
    • launch
    • foreground
    • background
    • pause
    • close
    • stop
    titleOptionalString

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

    showSplashOptionalBoolean

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

    showSpinnerOptionalBoolean

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

    splashBackgroundOptionalString

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

    preloadOptionalBoolean

    Indicates the current preload status.

    Possible values are:

    • full
    • semi-full
    • partial
    • minimal

    Note: It is included only when the event type is "preload".

    reasonOptionalString

    Indicates the reason behind the launching/closing of the target app.

    Note: It is included only when event type is "launch/close/stop".

    windowTypeOptionalString

    Indicates the windowType of the application.

    Note: It is included only when event type is "foreground".

    windowGroupOptionalString

    Indicates if the application has windowGroup or not.

    Note: It is included only when event type is "foreground".

    windowGroupOwnerOptionalString

    Indicates that the application has WindowGroupOwner or not.

    Note: It is included only when event type is "foreground".

    windowGroupOwnerIdOptionalString

    Indicates the windowGroupOwner of the application.

    Note: It is included only when event type is "foreground".

    statusOptionalString

    Indicates the current background status.

    Possible values are:

    • preload
    • normal

    Note: It is included only when event type is "background".

    Example

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

    Response:

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

    When livetv app is launched, outputs related to splash are shown like below.

    {
       "event":"splash",
       "title":"Live TV",
       "appId":"com.webos.app.livetv",
       "showSpinner":true,
       "showSplash":true,
       "returnValue":true,
       "splashBackground":"file:///usr/palm/applications/com.webos.app.livetv/assets/livetv.png"
    }

    For error case, if subscribe filed is empty, below error text is shown.

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

    Response:

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

    getAppBasePath

    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

    appIdRequiredString

    Indicates the appId.

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

    Indicates the appId.

    basePathOptionalString

    Indicates the application path.

    errorTextOptionalString

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

    errorCodeOptionalNumber

    The error code for the failed operation.

    Error Codes Reference

    Error Code

    Error Text

    Error Description

    NoneNot allowed. Allow only for the info of calling app itself.

    Not allowed. Allow only for the information of calling application itself.

    NoneError parsing request:Missing required key

    Missing required key.

    NoneError parsing request:Not string

    Invalid type value.

    Example

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

    getAppInfo

    Description

    Gets the application information.

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

    Parameters

    Name

    Required

    Type

    Description

    idRequiredString

    Indicates the id of the application.

    propertiesOptionalString array

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

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

    Indicates the appld.

    appInfoOptionalObject: appInfo

    If the getAppinfo method succeeds, the appInfo object contains information about the application.

    errorTextOptionalString

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

    errorCodeOptionalNumber

    The error code for the failed operation.

    Error Codes Reference

    Error Code

    Error Text

    Error Description

    NoneInvalid appId specified

    Invalid appId is specified. That is, the 'id' parameter is empty.

    Noneparameters must contain a 'id' (string)

    Parameters must contain an 'id' (string).

    NoneInvalid appId specified OR Unsupported Application Type

    Invalid appId is specified or an unsupported application type.

    Example

    # 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
    }

    getAppStatus

    Description

    Gets the application status and information.

    Parameters

    Name

    Required

    Type

    Description

    appIdRequiredString

    Indicates the appld.

    appInfoOptionalObject: appInfo

    Indicates the information of the application.

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

    Indicates the target appld.

    eventRequiredString

    Indicates event according to the target app status.

    statusRequiredString

    Indicates the current app status. 

    existRequiredBoolean

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

    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. 
    appInfoOptionalObject: appInfo

    If the getAppStatus method succeeds and the parameter "appInfo" is true, the appInfo object contains information about the application.

    errorCodeOptionalNumber (int8_t)

    The error code for the failed operation.

    errorTextOptionalString

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    Subscription Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    Indicates the status of operation.

    Possible values are:

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

    Indicates the target appld.

    eventRequiredString

    Indicates the event according to the target app status.

    statusRequiredString

    Indicates the current app status. 

    existRequiredBoolean

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

    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. 
    appInfoOptionalObject array: appInfo

    If the getAppStatus method succeeds and the parameter "appInfo" is true, the appInfo object contains information about the application.

    Example

    # 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
    }

    # 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 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"
    }

    listLaunchPoints

    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

    subscribeOptionalBoolean

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribed for notifications
    • false: Not subscribed

    ​​Default: false

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    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.

    subscribedRequiredBoolean

    Indicates if subscribed to get notifications.

    Possible values are:

    • true: Subscribed for notifications
    • false: Not subscribed
    launchPointsRequiredObject array: launchPoints

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

    Subscription Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

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

    Indicates if subscribed to get the notifications.

    Possible values are:

    • true: Subscribed for notifications
    • false: Not subscribed

    Default: true

    launchPointOptionalObject

    Returned if only one app's launchPoint is changed by updating/removing/installing.

    changeOptionalString

    Indicates the change in the status of the launch point.

    Possible values are:

    • added
    • updated
    • removed
    faviconOptionalString

    Favorite icon image displayed for the website.

    Example

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

    Response:

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

    addLaunchPoint

    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

    idRequiredString

    Indicates the application ID to be added.

    launchPointIdOptionalString

    Indicates the launchpoint ID to be added.

    titleOptionalString

    Indicates the launchpoint title.

    iconOptionalString

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

    bgImageOptionalString

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

    bgColorOptionalString

    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/

    imageForRecentsOptionalString

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

    iconColorOptionalString

    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/

    largeIconOptionalString

    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.

    appDescriptionOptionalString

    Indicates a brief description for the launchpoint.

    Note: The appDescription cannot exceed 60 characters.

    paramsOptionalObject: params

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

    bgImagesOptionalString array

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

    tileSizeOptionalString

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

    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

    userDataOptionalString

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

    policyCategoryOptionalString

    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.

    defaultAny9
    *$RESERVED_VALUE$RESERVED_LP$RESERVED_POSITION

    Value

    Launch Point Type

    position

    supportI18nTitleOptionalBoolean
    • 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
    faviconOptionalString

    Indicates the paths of the favorite icon for the launchpoint.

    relaunchOptionalBoolean

    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

    returnValueRequiredBoolean

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

    Indicates the launchpoint ID to be added.

    errorTextOptionalString

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

    errorCodeOptionalNumber

    The error code for the failed operation.

    Error Codes Reference

    Error Code

    Error Text

    Error Description

    Noneinvalid json request

    Invalid JSON request.

    Example

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

    Response:

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

    updateLaunchPoint

    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

    launchPointIdRequiredString

    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.

    titleOptionalString

    Indicates the launchpoint title.

    iconOptionalString

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

    bgImageOptionalString

    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/

    bgColorOptionalString

    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.

    imageForRecentsOptionalString

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

    iconColorOptionalString

    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/

    largeIconOptionalString

    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.

    appDescriptionOptionalString

    Indicates a brief description for the launchpoint.

    Note: The appDescription cannot exceed 60 characters.

    paramsOptionalObject: params

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

    bgImagesOptionalString array

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

    tileSizeOptionalString

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

    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

    userDataOptionalString

    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.

    iconsOptionalObject array

    Indicates the list of icon images.

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

    faviconOptionalString

    Indicates the favorite icon image displayed for the website.

    policyCategoryOptionalString

    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.

    ValueLaunch Point Typeposition
    defaultAny9
    *$RESERVED_VALUE$RESERVED_LP$RESERVED_POSITION
    relaunchOptionalBoolean

    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

    returnValueRequiredBoolean

    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.
    errorCodeOptionalNumber (int8_t)

    The error code for the failed operation.

    errorTextOptionalString

    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

    Noneinvalid json request

    Invalid JSON request.

    Nonecannot find launch point info

    Cannot find launch point information for launchPointId.

    Example

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

    Response:

    {
       "returnValue":true
    }

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

    Response:

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

    removeLaunchPoint

    Description

    Removes a dynamic launchpoint.

    Note: It can cause application uninstall.

    Parameters

    Name

    Required

    Type

    Description

    launchPointIdRequiredString

    Indicates the launchpoint ID to be removed.

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    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.
    errorCodeOptionalNumber (int8_t)

    The error code for the failed operation.

    errorTextOptionalString

    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

    Noneinvalid json request

    Invalid JSON request.

    Nonecannot find launch point info

    Cannot find launch point information for launchPointId.

    Example

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

    Response:

    {
       "returnValue":true
    }

    registerApp

    Description

    Registers a native application.

    Note:

    • This method should be called by launched native application to indicate if it is ready to receive several events.
    • Each event is communicated via the ls message connection and the reply will be delivered only to the app that is performing the action.

    Parameters

    None

    Call Returns

    Name

    Required

    Type

    Description

    returnValueRequiredBoolean

    Indicates the status of the operation.

    Possible values are:

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

    If a native application is successfully registered, event will contain registered.

    Subscription Returns

    Name

    Required

    Type

    Description

    eventRequiredString

    It indicates one of events the app should handle.

    returnValueRequiredBoolean

    Indicates the status of the operation.

    Possible values are:

    • true: Indicates that the operation was successful.
    • false: Indicates that the operation failed.
    parametersOptionalObject: params

    Indicates the information to be delivered to the registered app.

    reasonOptionalString

    Indicates the reason for the app to be launched/closed.

    appIdOptionalString

    Indicates the ID of the registered app. 

    Example

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

    {

    "event":"registered",

    "returnValue":true

    }

     

    //event is returned when an app status is changed.

    {

    "event":"pause",

    "reason":"keepAlive",

    "parameters":{},

    "returnValue":true

    }

    lockApp

    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

    idRequiredString

    The application ID to be locked.

    lockRequiredBoolean

    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

    returnValueRequiredBoolean

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

    Indicates if the application is locked or unlocked.

    Possible values are:

    • true: The application is locked
    • false: The application is unlocked
    idRequiredString

    Indicates the application ID which is locked or unlocked.

    errorTextOptionalString

    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

    NoneMissing required key

    Missing required key.

    NoneParameters 'id'(string) or 'lock'(bool) is missing

    Parameters 'id'(string) or 'lock'(bool) is missing.

    Nonewas not found OR Unsupported Application Type

    Was not found or an unsupported application type.

    Objects

    appInfo

    Contains the information about the application.

    Name

    Required

    Type

    Description

    idRequiredString

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

    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.

    titleRequiredString

    Indicates the application title as it is shown in the launcher and in the application window.

    Note: The application title is unique, set once.

    iconRequiredString

    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\"

    largeIconOptionalString

    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.

    typeRequiredString

    The application type; web or pdk.

    splashBackgroundOptionalString

    The background image to be shown while application is loading, e.g., splash-background.png.

    vendorOptionalString

    The application owner used in the launcher and deviceinfo dialogs.

    transparentOptionalBoolean

    This indicates whether the web application's background is transparent or not.

    versionOptionalString

    The application version number, in the dot-notation format, e.g., 3.0.2500.

    handlesRelaunchOptionalBoolean

    This indicates whether the application is relaunched or not when a user executes application that is already running.

    requiredMemoryOptionalNumber (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.

    iconColorOptionalString

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

    appDescriptionOptionalString

    A short description for the application. The appDescription cannot exceed 60 characters.

    launchPoints

    Contains the array of launchpoints.

    Name

    Required

    Type

    Description

    lptypeRequiredString

    The launchpoint type: default, bookmark, group.

    idRequiredString

    The application ID of the launchpoint.

    launchPointIdRequiredString

    The unique launchpoint ID.

    removableRequiredBoolean

    This indicates whether the application is removable or not.

    titleRequiredString

    The application title as it is shown in the Launcher and in the application window. The application title is unique, set once.

    iconRequiredString

    The image displayed for the application.

    iconColorRequiredString

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

    largeIconRequiredString

    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.

    appDescriptionRequiredString

    A short description for the application. The appDescription cannot exceed 60 characters.

    paramsOptionalObject: params

    The params object contains information on the target application. You should specify correct parameters for each application.

    userDataOptionalString

    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.

    foregroundAppInfo

    The object contains sorted foreground applications in ascending order.

    Name

    Required

    Type

    Description

    instanceIdOptionalString

    InstanceId of running application.

    appIdRequiredString

    The application ID.

    windowIdRequiredString

    The window ID of the application running in the foreground.

    processIdRequiredString

    The process ID of the application running in the foreground.

    displayIdOptionalNumber

    The display ID of application.

    running

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

    Name

    Required

    Type

    Description

    idRequiredString

    The application ID.

    launchPointIdOptionalString

    The launch point ID of the app. 

    instanceIdOptionalString

    The instance ID of the app.

    displayIdOptionalNumber

    The display ID of the app.

    processIdRequiredString

    The process ID of the application.

    webprocessidRequiredString

    The webprocess ID of the application.

    defaultWindowTypeRequiredString

    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
    appTypeRequiredString

    The application type.

    API Error Codes Reference

    Error Code

    Error Text

    Error Description

    NoneMissing required key

    Missing required key.

    Noneinvalid json request

    Invalid JSON request.

    -102[ID] has been locked.

    Application has been locked.

    -203[ID] is already launching

    The native application is already launching.

    -312not allowed

    EULA is not accepted.

    Contents