IPackageInstaller Class Reference

How packages get installed. More...

#include <C:/Users/kirby/Documents/Github/deki/deki-editor/deki-editor/include/deki-editor/PackageContract.h>

Public Member Functions
virtual	~IPackageInstaller ()=default
virtual std::string	GetId () const =0
	Stable identity written to project files (the lock's "installer" and, for a component from the framework's own registry, the manifest's "source").
virtual std::string	GetPlatformName () const =0
	What the user sees.
virtual bool	IsApplicable (const std::string &projectPath) const =0
	True when this installer applies to the project at projectPath.
virtual std::vector< PackageEntry >	GetInstalledPackages (const std::string &projectPath)=0
	The packages this installer has installed in the project.
virtual void	Install (const std::string &projectPath, const PackageEntry &pkg, const std::string &version, PackageCallback callback)=0
virtual void	Remove (const std::string &projectPath, const PackageEntry &pkg, PackageCallback callback)=0
virtual std::vector< CoreDependency >	GetCoreDependencies () const =0
virtual void	EnsureCoreDependencies (const std::string &projectPath)=0
virtual bool	IsCoreDependency (const std::string &name) const =0

Detailed Description

How packages get installed.

Constructor & Destructor Documentation

~IPackageInstaller()

virtual IPackageInstaller::~IPackageInstaller ( )

virtualdefault

Member Function Documentation

GetId()

virtual std::string IPackageInstaller::GetId ( ) const

pure virtual

Stable identity written to project files (the lock's "installer" and, for a component from the framework's own registry, the manifest's "source").

A lowercase identifier, by convention the framework id of the backend the same package ships. Never shown to the user. Never change it once released: renaming it orphans every project's entries.

GetPlatformName()

virtual std::string IPackageInstaller::GetPlatformName ( ) const

pure virtual

What the user sees.

IsApplicable()

virtual bool IPackageInstaller::IsApplicable ( const std::string & projectPath ) const

pure virtual

True when this installer applies to the project at projectPath.

GetInstalledPackages()

virtual std::vector< PackageEntry > IPackageInstaller::GetInstalledPackages ( const std::string & projectPath )

pure virtual

The packages this installer has installed in the project.

Install()

virtual void IPackageInstaller::Install ( const std::string & projectPath, const PackageEntry & pkg, const std::string & version, PackageCallback callback )

pure virtual

Remove()

virtual void IPackageInstaller::Remove ( const std::string & projectPath, const PackageEntry & pkg, PackageCallback callback )

pure virtual

GetCoreDependencies()

virtual std::vector< CoreDependency > IPackageInstaller::GetCoreDependencies ( ) const

pure virtual

EnsureCoreDependencies()

virtual void IPackageInstaller::EnsureCoreDependencies ( const std::string & projectPath )

pure virtual

IsCoreDependency()

virtual bool IPackageInstaller::IsCoreDependency ( const std::string & name ) const

pure virtual

---

The documentation for this class was generated from the following file:

• deki-editor/include/deki-editor/PackageContract.h