# Package Management
App package management.
# Manifest Declaration
You need to declare the use of this API in the manifest's features
member:
{"name": "system.package"}
# Module Import
Before using this service in a component, you need to import the module in the script section of the UX document.
import pkg from '@system.package'
Or
let pkg = require("@system.package")
# Methods
This service has the following methods:
method()
hasInstalled({package,success,fail,complete})
install({package,success,fail,complete})
getInfo({package,success,fail,complete})
getSignatureDigests({package,success,fail,complete})
# hasInstalled({package,success,fail,complete})
Method that checks whether a native or quick app is installed in the system.
A quick app is considered as installed only when it has a home screen created.
# Arguments
This method requires an object
with the following attributes:
package
(string
). Mandatory attribute with the package name that identifies an app.success
(function(res)
). Optional callback function corresponding to the successful execution.res.result
is aboolean
that indicates whether the app exists or not.
fail
(function(res, code)
). Optional callback function corresponding to the failed execution.complete
(function()
). Optional callback function corresponding to the end of the execution.
Example:
pkg.hasInstalled({
package: 'org.example.myapp',
success: function(data) {
console.log("handling success: " + data.result);
},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})
# install({package,success,fail,complete})
This method opens the app details page on a app marketplace where the user can install the native app.
This method does not check whether the installation is successful.
# Arguments
This method requires an object
with the following attributes:
package
(string
). Mandatory attribute with the package name that identifies an app.success
(function(res)
). Optional callback function corresponding to the successful execution.res.result
is aboolean
that indicates whether the app exists or not on the marketplace.
fail
(function(res, code)
). Optional callback function corresponding to the failed execution.complete
(function()
). Optional callback function corresponding to the end of the execution.
Example:
pkg.install({
package: 'org.example.myapp',
success: function(data) {
console.log("handling success: " + data.result);
},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})
# getInfo({package,success,fail,complete})
This method gets the version name and version code of an app.
# Arguments
This method requires an object
with the following attributes:
package
(string
). Mandatory attribute with the package name that identifies an app.success
(function(res)
). Optional callback function corresponding to the successful execution.res.versionCode
is anumber
that indicates the version code of the package name indicated inpackage
.res.versionName
is astring
that indicates the version name of the package name indicated inpackage
.
fail
(function(res, code)
). Optional callback function corresponding to the failed execution with the following result codes:202
: Invalid parameter.1000
: No apps found.
complete
(function()
). Optional callback function corresponding to the end of the execution.
Example:
pkg.getInfo({
package: 'org.example.myapp',
success: function(data) {
console.log(`handling success: ${data.versionCode}, ${data.versionName}`)
},
fail: function(data, code) {
console.log("handling fail, code=" + code);
}
})
# getSignatureDigests({package,success,fail,complete})
Method to get the app signature digests.
It could be a quick app or a native app.
# Arguments
This method requires an object
with the following attributes:
package
(string
). Mandatory attribute with the package name that identifies an app.success
(function(res)
). Optional callback function corresponding to the successful execution.res.signatureDigests
is anarray
with the list of signatures encrypted using the SHA-256 algorithm.res.versionName
is astring
that indicates the version name of the package name indicated inpackage
.
fail
(function(res, code)
). Optional callback function corresponding to the failed execution with the following result codes:202
: Invalid parameter.1000
: No apps found.
complete
(function()
). Optional callback function corresponding to the end of the execution.
Example:
pkg.getSignatureDigests({
package: 'org.example.myapp',
success: function (data) {
data.signatureDigests.map(function (item) {
console.log(`handling success: signatureDigests = ${item}`)
})
},
fail: function (data, code) {
console.log(`handling fail, code = ${code}`)
}
})
← Logging Page Routing →