Public methods:

install

Public.

com.palm.appinstaller/install

Install an application.

Syntax:

{
    "target": string,
    "id": string,
    "uncompressedSize": integer,
    "subscribe": boolean
}

Parameters

target	Package file. Required.
id	ID for the package.
uncompressedSize	Uncompressed size of the package.
subscribe	Set to true to receive status change events.

Returns when installation request is made:

{
    "returnValue": boolean,
    "subscribed": boolean,
    "ticket": string
}

Parameters

returnValue	Indicates if the call was succesful.
subscribed	Indicates if subscribed to receive status change events.
ticket	Identifier that was assigned for the installation request.

Returns when status changes:

{
    "ticket": int,
    "status": string
}

Parameters

ticket	Identifier that was assigned for the installation request.
status	Describes the installation status.

Examples:

luna-send -n 10 -f luna://com.palm.appinstaller/install '{ "target": "/tmp/apackage", "id": "com.whatnot.package", "uncompressedSize": 100, "subscribe": true }'

Example response for a succesful call:

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

Example status updates for a failed installation when subscribed:

{
    "ticket": 6,
    "status": "STARTING"
}
{
    "ticket": 6,
    "status": "FAILED_PACKAGEFILE_NOT_FOUND"
}
{
    "ticket": 6,
    "status": "FAILED_IPKG_INSTALL"
}

Example response for a failed call:

{
    "returnValue": false,
    "subscribed": false
}

installNoVerify

Public.

com.palm.appinstaller/installNoVerify

Install a package without verification.

Syntax:

{
    "target": string,
    "uncompressedSize": integer,
    "systemMode": boolean,
    "subscribe": boolean
}

Parameters

target	Package file. Required.
uncompressedSize	Uncompressed size of the package.
systemMode	Set to true to turn on system mode, which disables ipkg flags.
subscribe	Set to true to receive status change events.

Returns for a call:

{
    "returnValue": boolean,
    "ticket": int,
    "subscribed": boolean
}

Parameters

returnValue	Indicates if the call was succesful.
ticket	Identifier that was assigned for the installation request.
subscribed	Indicates if subscribed to receive status change events.

Returns for status change events:

{
    "ticket": int,
    "status": string
}

Parameters

ticket	Identifier that was assigned for the installation request.
status	Describes the installation status.

Examples:

luna-send -n 10 -f luna://com.palm.appinstaller/installNoVerify '{ "target": "/tmp/apackage", "uncompressedSize": 100, "systemMode": true, "subscribe": true }'

Example response for a succesful call:

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

Example of status changes for a failed installation:

{
    "ticket": 1,
    "status": "STARTING"
}
{
    "ticket": 1,
    "status": "FAILED_PACKAGEFILE_NOT_FOUND"
}
{
    "ticket": 1,
    "status": "FAILED_IPKG_INSTALL"
}

Example response for a failed call:

{
    "returnValue": false,
    "errorCode": "Failed to find param target in message"
}

remove

Public.

com.palm.appinstaller/remove

Remove a package.

Syntax:

{
    "packageName": string,
    "subscribe": boolean
}

Parameters

packageName	Name of the package to remove.
subscribe	Set to true to receive events on status changes.

Returns for a call:

{
    "ticket": int,
    "returnValue": boolean,
    "version": version,
    "subscribed": boolean
}

Parameters

ticket	Identifier for the removal.
returnValue	Indicates if the call was succesful.
version	Installed version of the package.
subscribed	Indicates if subscribed to receive status change events.

Returns when ticket status changes:

{
    "ticket": int,
    "status": string
}

Parameters

ticket	Identifier for the removal.
status	Describes the status of the remove action.

Examples:

luna-send -n 10 -f luna://com.palm.appinstaller/remove '{ "packageName": "com.palm.app.email", "subscribe": true }'

Example response for a succesful call:

{
    "ticket": 6,
    "returnValue": true,
    "version": "3.0.13801",
    "subscribed": true
}

Examples of removal status changes:

{
    "ticket": 6,
    "status": "IPKG_REMOVE"
}
{
    "ticket": 6,
    "status": "SUCCESS"
}

Example response for a failed call:

{
    "returnValue": false
}

notifyOnChange

Public.

com.palm.appinstaller/notifyOnChange

Subscribe to receive notifications when applications are installed or removed.

Syntax:

{
    "appId": string
}

Parameters

appId ID of the application to watch. If not specified, notifications are received for all applications.

Returns on call:

{
    "returnValue": boolean,
    "subscribed": boolean,
    "appId":string
}

Parameters

returnValue	Indicates if the call was succesful.
subscribed	True when subscribed to receive change events.
appId	ID of the watched application, or * in case all applications are watched.

Returns on status changes:

{
    "appId": string,
    "version": string,
    "statusChange": string,
    "cause": string
}

Parameters

appId	ID of the application.
version	Version of the application.
statusChange	Describes the status change.
cause	What caused the change.

Examples:

luna-send -n 10 -f luna://com.palm.appinstaller/notifyOnChange '{ "appId": "com.palm.app.email" }'

Example response for a succesful call:

{
    "returnValue": true,
    "subscribed": true,
    "appId": "com.palm.app.email"
}

Example of an application removal:

{
    "appId": "com.palm.app.email",
    "version": "3.0.13801",
    "statusChange": "REMOVED",
    "cause": "USER"
}

getUserInstalledAppSizes

Public.

com.palm.appinstaller/getUserInstalledAppSizes

Get sizes for user installed applications.

Syntax:

{

}

Returns:

{
    "returnValue": boolean,
    "apps": [
        {
            "appName": string,
            "size": int
        }
    ],
    "totalSize": int
}

Parameters

returnValue	Indicates if the call was succesful.
apps	Object array, see fields of contained objects below.
appName	Name of the application.
size	Size of the application in kilobytes.
totalSize	Combined size of all the applications in kilobytes.

Examples:

luna-send -n 1 -f luna://com.palm.appinstaller/getUserInstalledAppSizes '{ }'

Example response for a succesful call:

{
    "returnValue": true,
    "apps": [
        {
            "appName": "com.palm.app.enyo-facebook",
            "size": 0
        },
        {
            "appName": "com.palm.app.enyo-findapps",
            "size": 0
        },
        {
            "appName": "com.palm.app.kindle",
            "size": 0
        },
        {
            "appName": "com.palm.app.youtube",
            "size": 0
        },
        {
            "appName": "com.quickoffice.ar",
            "size": 0
        },
        {
            "appName": "com.quickoffice.webos",
            "size": 0
        }
    ],
    "totalSize": 0
}

queryInstallCapacity

Public.

com.palm.appinstaller/queryInstallCapacity

Query for the space that is available, and space that is required to install an application package.

Syntax:

{
    "appId": string,
    "packageId": string,
    "size": string,
    "uncompressedSize": string
}

Parameters

appId	Application ID. Either this, or packageId is required.
packageId	Package ID. Either this, or appId is required.
size	Size of the package in kilobytes. Required.
uncompressedSize	Uncompressed size of the package in kilobytes.

Returns:

{
    "returnValue": boolean,
    "result": int,
    "spaceNeededInKB": string,
    "errorCode": string,
    "errorText": string
}

Parameters

returnValue	Indicates if the call was succesful.
result	Available space in kilobytes.
spaceNeededInKB	Space required to install the package.
errorCode	Error code in case the call failed.
errorText	Describes the error in more detail.

Examples:

luna-send -n 1 -f luna://com.palm.appinstaller/queryInstallCapacity '{ "packageId": "com.whatnot.app", "size": "300", "uncompressedSize": "1200" }'

Example response for a succesful call:

{
    "returnValue": true,
    "result": 0,
    "spaceNeededInKB": "1536"
}

Example response for a failed call:

{
    "returnValue": false,
    "errorCode": "appinstaller_error",
    "errorText": "missing size parameter"
}

revoke

Public.

com.palm.appinstaller/revoke

Revoke one on more applications.

Syntax:

{
    "item": {
        "payload": {
            "signature": string,
            "appId": [ string array ]
        }
    }
}

Parameters

item	Object.
payload	Object.
signature	Valid signature required to revoke applications.
appId	IDs of applications to revoke

Returns:

{
    "returnValue": boolean,
    "errorCode": string
}

Parameters

returnValue	Indicates if the call was succesful.
errorCode	Describes the error if call was not succesful.

Examples:

luna-send -n 1 -f luna://com.palm.appinstaller/revoke '{ "item": { "payload": { "signature": "notAValidSignature", "appId": ["com.palm.app.oneApp", "com.palm.app.anotherApp" ] } } }'

Example response for a succesful call:

{
    "returnValue": true
}

Example response for a failed call:

{
    "returnValue": false,
    "errorCode": "verify failed"
}