Skip to content

Latest commit

 

History

History
140 lines (99 loc) · 3.83 KB

PreinstallManager.md

File metadata and controls

140 lines (99 loc) · 3.83 KB

PreinstallManager Plugin

Version: 1.0.0

A PreinstallManager plugin for Thunder framework.

Table of Contents

Abbreviation, Acronyms and Terms

[Refer to this link]

Description

The PreinstallManager plugin provides an interface for PreinstallManager.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name Type Description
callsign string Plugin instance name (default: org.rdk.PreinstallManager)
classname string Class name: PreinstallManager
locator string Library name: libWPEFrameworkPreinstallManager.so
autostart boolean Determines if the plugin shall be started automatically along with the framework

Methods

The following methods are provided by the PreinstallManager plugin:

PreinstallManager interface methods:

Method Description
startPreinstall Checks the preinstall directory for packages to be preinstalled and installs them as needed.

startPreinstall

Checks the preinstall directory for packages to be preinstalled and installs them as needed.

Events

Event details will be updated soon.

Parameters

Name Type Description
params object
params.forceInstall bool If true always install the app; if false then install only if not installed or existing is older version

Results

Name Type Description
result null On success null will be returned.

Examples

Request

{
    "jsonrpc": 2.0,
    "id": 0,
    "method": "org.rdk.PreinstallManager.startPreinstall",
    "params": {
        "forceInstall": true
    }
}

CURL Command

curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.PreinstallManager.startPreinstall", "params": {"forceInstall": true}}' http://127.0.0.1:9998/jsonrpc

Response

{
    "jsonrpc": 2.0,
    "id": 0,
    "result": null
}

Notifications

Notifications are autonomous events, triggered by the internals of the implementation, and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the PreinstallManager plugin:

PreinstallManager interface events:

Event Description
onAppInstallationStatus Emitted when the installation of a preinstalled app succeeds or fails.

onAppInstallationStatus

Emitted when the installation of a preinstalled app succeeds or fails.

Parameters

Name Type Description
params object
params.jsonresponse string Output installation status details as string object

Examples

{
    "jsonrpc": 2.0,
    "id": 1,
    "method": "org.rdk.PreinstallManager.onAppInstallationStatus",
    "params": {
        "jsonresponse": ""
    }
}