LocalPackage
LocalPackage
#include <icy/pacm/package.h>struct LocalPackageDefined in src/pacm/include/icy/pacm/package.h:189
Inherits:
Package
Package metadata for an installed package on the local filesystem.
List of all members
| Name | Kind | Owner |
|---|---|---|
LocalPackage | function | Declared here |
LocalPackage | function | Declared here |
LocalPackage | function | Declared here |
~LocalPackage | function | Declared here |
setState | function | Declared here |
setInstallState | function | Declared here |
setInstallDir | function | Declared here |
setInstalledAsset | function | Declared here |
setVersion | function | Declared here |
setVersionLock | function | Declared here |
setSDKVersionLock | function | Declared here |
version | function | Declared here |
state | function | Declared here |
installState | function | Declared here |
installDir | function | Declared here |
versionLock | function | Declared here |
sdkLockedVersion | function | Declared here |
asset | function | Declared here |
isInstalled | function | Declared here |
isFailed | function | Declared here |
manifest | function | Declared here |
verifyInstallManifest | function | Declared here |
getInstalledFilePath | function | Declared here |
extensionEntryPointPath | function | Declared here |
errors | function | Declared here |
addError | function | Declared here |
lastError | function | Declared here |
clearErrors | function | Declared here |
valid | function | Declared here |
Package | function | Inherited from Package |
Package | function | Inherited from Package |
~Package | function | Inherited from Package |
id | function | Inherited from Package |
name | function | Inherited from Package |
type | function | Inherited from Package |
author | function | Inherited from Package |
description | function | Inherited from Package |
hasExtension | function | Inherited from Package |
extension | function | Inherited from Package |
valid | function | Inherited from Package |
toJson | function | Inherited from Package |
print | function | Inherited from Package |
Inherited from Package
| Kind | Name | Description |
|---|---|---|
function | Package | Constructs an empty package. |
function | Package | Constructs a package from an existing JSON value. |
function | ~Package virtual noexcept | |
function | id virtual const | Returns the package unique identifier. |
function | name virtual const | Returns the package display name. |
function | type virtual const | Returns the package type (e.g. "plugin", "asset"). |
function | author virtual const | Returns the package author string. |
function | description virtual const | Returns the package description string. |
function | hasExtension virtual const | Returns true when the package has an "extension" object. |
function | extension virtual const | Returns a read-only view of the extension metadata. Throws if no extension object is present. |
function | valid virtual const | Returns true if id, name and type are all non-empty. |
function | toJson virtual const | Returns a plain JSON copy of this package object. |
function | print virtual const | Dumps the JSON representation of this package to ost. |
Public Methods
| Return | Name | Description |
|---|---|---|
LocalPackage | Constructs an empty local package. | |
LocalPackage | Constructs a local package from an existing JSON value. | |
LocalPackage | Create the local package from the remote package reference with the following manipulations. 1) Add a local manifest element. 2) Remove asset mirror elements. | |
void | setState virtual | Set's the overall package state. Possible values are: Installing, Installed, Failed, Uninstalled. If the packages completes while still Installing, this means the package has yet to be finalized. |
void | setInstallState virtual | Set's the package installation state. See InstallationState for possible values. |
void | setInstallDir virtual | Set's the installation directory for this package. |
void | setInstalledAsset virtual | Sets the installed asset, once installed. This method also sets the version. |
void | setVersion virtual | Sets the current version of the local package. Installation must be complete. |
void | setVersionLock virtual | Locks the package at the given version. Once set this package will not be updated past the given version. Pass an empty string to remove the lock. |
void | setSDKVersionLock virtual | Locks the package at the given SDK version. Once set this package will only update to the most recent version with given SDK version. Pass an empty string to remove the lock. |
std::string | version virtual const | Returns the installed package version. |
std::string | state virtual const | Returns the current state of this package. |
std::string | installState virtual const | Returns the installation state of this package. |
std::string | installDir virtual const | Returns the installation directory for this package. |
std::string | versionLock virtual const | Returns the pinned version string, or empty if no lock is set. |
std::string | sdkLockedVersion virtual const | Returns the pinned SDK version string, or empty if no lock is set. |
Asset | asset virtual | Returns the currently installed asset, if any. If none, the returned asset will be empty(). |
bool | isInstalled virtual const | Returns true or false depending on weather or not the package is installed successfully. False if package is in Failed state. |
bool | isFailed virtual const | Returns true if the package state is "Failed". |
Manifest | manifest virtual | Returns the installation manifest. |
bool | verifyInstallManifest virtual | |
std::string | getInstalledFilePath virtual | Returns the full full path of the installed file. Thrown an exception if the install directory is unset. |
std::string | extensionEntryPointPath virtual const | Returns the install-relative extension entrypoint resolved against installDir(). Returns an empty string when no extension metadata is present. |
json::Value & | errors virtual | Returns a reference to the JSON array of accumulated error messages. |
void | addError virtual | Appends message to the errors array. |
std::string | lastError virtual const | Returns the most recently added error message, or empty if none. |
void | clearErrors virtual | Clears all recorded error messages. |
bool | valid virtual const | Returns true if id, name and type are all non-empty. |
LocalPackage
LocalPackage()Defined in src/pacm/include/icy/pacm/package.h:213
Constructs an empty local package.
LocalPackage
LocalPackage(const json::Value & src)Defined in src/pacm/include/icy/pacm/package.h:217
Constructs a local package from an existing JSON value.
Parameters
srcJSON object containing local package fields.
LocalPackage
LocalPackage(const RemotePackage & src)Defined in src/pacm/include/icy/pacm/package.h:223
Create the local package from the remote package reference with the following manipulations. 1) Add a local manifest element. 2) Remove asset mirror elements.
setState
virtual
virtual void setState(const std::string & state)Defined in src/pacm/include/icy/pacm/package.h:232
Set's the overall package state. Possible values are: Installing, Installed, Failed, Uninstalled. If the packages completes while still Installing, this means the package has yet to be finalized.
setInstallState
virtual
virtual void setInstallState(const std::string & state)Defined in src/pacm/include/icy/pacm/package.h:236
Set's the package installation state. See InstallationState for possible values.
setInstallDir
virtual
virtual void setInstallDir(const std::string & dir)Defined in src/pacm/include/icy/pacm/package.h:239
Set's the installation directory for this package.
setInstalledAsset
virtual
virtual void setInstalledAsset(const Package::Asset & installedRemoteAsset)Defined in src/pacm/include/icy/pacm/package.h:243
Sets the installed asset, once installed. This method also sets the version.
setVersion
virtual
virtual void setVersion(const std::string & version)Defined in src/pacm/include/icy/pacm/package.h:247
Sets the current version of the local package. Installation must be complete.
setVersionLock
virtual
virtual void setVersionLock(const std::string & version)Defined in src/pacm/include/icy/pacm/package.h:253
Locks the package at the given version. Once set this package will not be updated past the given version. Pass an empty string to remove the lock.
setSDKVersionLock
virtual
virtual void setSDKVersionLock(const std::string & version)Defined in src/pacm/include/icy/pacm/package.h:259
Locks the package at the given SDK version. Once set this package will only update to the most recent version with given SDK version. Pass an empty string to remove the lock.
version
virtual const
virtual std::string version() constDefined in src/pacm/include/icy/pacm/package.h:262
Returns the installed package version.
state
virtual const
virtual std::string state() constDefined in src/pacm/include/icy/pacm/package.h:265
Returns the current state of this package.
installState
virtual const
virtual std::string installState() constDefined in src/pacm/include/icy/pacm/package.h:268
Returns the installation state of this package.
installDir
virtual const
virtual std::string installDir() constDefined in src/pacm/include/icy/pacm/package.h:271
Returns the installation directory for this package.
versionLock
virtual const
virtual std::string versionLock() constDefined in src/pacm/include/icy/pacm/package.h:275
Returns the pinned version string, or empty if no lock is set.
sdkLockedVersion
virtual const
virtual std::string sdkLockedVersion() constDefined in src/pacm/include/icy/pacm/package.h:278
Returns the pinned SDK version string, or empty if no lock is set.
asset
virtual
virtual Asset asset()Defined in src/pacm/include/icy/pacm/package.h:282
Returns the currently installed asset, if any. If none, the returned asset will be empty().
isInstalled
virtual const
virtual bool isInstalled() constDefined in src/pacm/include/icy/pacm/package.h:287
Returns true or false depending on weather or not the package is installed successfully. False if package is in Failed state.
isFailed
virtual const
virtual bool isFailed() constDefined in src/pacm/include/icy/pacm/package.h:290
Returns true if the package state is "Failed".
manifest
virtual
virtual Manifest manifest()Defined in src/pacm/include/icy/pacm/package.h:293
Returns the installation manifest.
verifyInstallManifest
virtual
virtual bool verifyInstallManifest(bool allowEmpty = false)Defined in src/pacm/include/icy/pacm/package.h:295
getInstalledFilePath
virtual
virtual std::string getInstalledFilePath(const std::string & fileName, bool whiny = false)Defined in src/pacm/include/icy/pacm/package.h:299
Returns the full full path of the installed file. Thrown an exception if the install directory is unset.
extensionEntryPointPath
virtual const
virtual std::string extensionEntryPointPath(bool whiny = false) constDefined in src/pacm/include/icy/pacm/package.h:304
Returns the install-relative extension entrypoint resolved against installDir(). Returns an empty string when no extension metadata is present.
errors
virtual
virtual json::Value & errors()Defined in src/pacm/include/icy/pacm/package.h:307
Returns a reference to the JSON array of accumulated error messages.
addError
virtual
virtual void addError(const std::string & message)Defined in src/pacm/include/icy/pacm/package.h:311
Appends message to the errors array.
Parameters
messageError description to record.
lastError
virtual const
virtual std::string lastError() constDefined in src/pacm/include/icy/pacm/package.h:314
Returns the most recently added error message, or empty if none.
clearErrors
virtual
virtual void clearErrors()Defined in src/pacm/include/icy/pacm/package.h:317
Clears all recorded error messages.
valid
virtual const
virtual bool valid() constDefined in src/pacm/include/icy/pacm/package.h:319
Returns true if id, name and type are all non-empty.
