RemotePackage
RemotePackage
#include <icy/pacm/package.h>struct RemotePackageDefined in src/pacm/include/icy/pacm/package.h:151
Inherits:
Package
Package metadata loaded from the remote package index.
List of all members
| Name | Kind | Owner |
|---|---|---|
RemotePackage | function | Declared here |
RemotePackage | function | Declared here |
~RemotePackage | function | Declared here |
assets | function | Declared here |
latestAsset | function | Declared here |
assetVersion | function | Declared here |
latestSDKAsset | 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 |
|---|---|---|
RemotePackage | Constructs an empty remote package. | |
RemotePackage | Constructs a remote package from an existing JSON value. | |
json::Value & | assets virtual | Returns a reference to the "assets" JSON array node. |
Asset | latestAsset virtual | Returns the latest asset for this package. For local packages this is the currently installed version. For remote packages this is the latest available version. Throws an exception if no asset exists. |
Asset | assetVersion virtual | Returns the latest asset for the given package version. Throws an exception if no asset exists. |
Asset | latestSDKAsset virtual | Returns the latest asset for the given SDK version. This method is for safely installing plug-ins which must be compiled against a specific SDK version. The package JSON must have a "sdk-version" member for this function to work as intended. Throws an exception if no asset exists. |
RemotePackage
RemotePackage()Defined in src/pacm/include/icy/pacm/package.h:154
Constructs an empty remote package.
RemotePackage
RemotePackage(const json::Value & src)Defined in src/pacm/include/icy/pacm/package.h:158
Constructs a remote package from an existing JSON value.
Parameters
srcJSON object containing remote package fields.
assets
virtual
virtual json::Value & assets()Defined in src/pacm/include/icy/pacm/package.h:162
Returns a reference to the "assets" JSON array node.
latestAsset
virtual
virtual Asset latestAsset()Defined in src/pacm/include/icy/pacm/package.h:168
Returns the latest asset for this package. For local packages this is the currently installed version. For remote packages this is the latest available version. Throws an exception if no asset exists.
assetVersion
virtual
virtual Asset assetVersion(const std::string & version)Defined in src/pacm/include/icy/pacm/package.h:172
Returns the latest asset for the given package version. Throws an exception if no asset exists.
latestSDKAsset
virtual
virtual Asset latestSDKAsset(const std::string & version)Defined in src/pacm/include/icy/pacm/package.h:180
Returns the latest asset for the given SDK version. This method is for safely installing plug-ins which must be compiled against a specific SDK version. The package JSON must have a "sdk-version" member for this function to work as intended. Throws an exception if no asset exists.
