#include <IAddon.h>

Inheritance diagram for ADDON::IAddon:

Public Member Functions
virtual	~IAddon ()=default

virtual AddonType	MainType () const =0

virtual AddonType	Type () const =0

virtual bool	HasType (AddonType type) const =0

virtual bool	HasMainType (AddonType type) const =0

virtual std::string	ID () const =0

virtual std::string	Name () const =0

virtual bool	IsInUse () const =0

virtual bool	IsBinary () const =0

virtual CAddonVersion	Version () const =0

virtual CAddonVersion	MinVersion () const =0

virtual std::string	Summary () const =0

virtual std::string	Description () const =0

virtual std::string	Path () const =0

virtual std::string	Profile () const =0

virtual std::string	LibPath () const =0

virtual std::string	ChangeLog () const =0

virtual std::string	FanArt () const =0

virtual ArtMap	Art () const =0

virtual std::vector< std::string >	Screenshots () const =0

virtual std::string	Author () const =0

virtual std::string	Icon () const =0

virtual std::string	Disclaimer () const =0

virtual AddonLifecycleState	LifecycleState () const =0

virtual std::string	LifecycleStateDescription () const =0

virtual CDateTime	InstallDate () const =0

virtual CDateTime	LastUpdated () const =0

virtual CDateTime	LastUsed () const =0

virtual std::string	Origin () const =0

virtual std::string	OriginName () const =0

virtual uint64_t	PackageSize () const =0

virtual const InfoMap &	ExtraInfo () const =0

virtual bool	SupportsMultipleInstances () const =0

virtual AddonInstanceSupport	InstanceUseType () const =0

virtual std::vector< AddonInstanceId >	GetKnownInstanceIds () const =0

virtual bool	SupportsInstanceSettings () const =0

virtual bool	DeleteInstanceSettings (AddonInstanceId instance)=0

virtual bool	CanHaveAddonOrInstanceSettings ()=0

virtual bool	HasSettings (AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	HasUserSettings (AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	SaveSettings (AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual void	UpdateSetting (const std::string &key, const std::string &value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	UpdateSettingBool (const std::string &key, bool value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	UpdateSettingInt (const std::string &key, int value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	UpdateSettingNumber (const std::string &key, double value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	UpdateSettingString (const std::string &key, const std::string &value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual std::string	GetSetting (const std::string &key, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	GetSettingBool (const std::string &key, bool &value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	GetSettingInt (const std::string &key, int &value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	GetSettingNumber (const std::string &key, double &value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual bool	GetSettingString (const std::string &key, std::string &value, AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual std::shared_ptr< CAddonSettings >	GetSettings (AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual const std::vector< DependencyInfo > &	GetDependencies () const =0

virtual CAddonVersion	GetDependencyVersion (const std::string &dependencyID) const =0

virtual bool	MeetsVersion (const CAddonVersion &versionMin, const CAddonVersion &version) const =0

virtual bool	ReloadSettings (AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual void	ResetSettings (AddonInstanceId id=ADDON_SETTINGS_ID)=0

virtual AddonPtr	GetRunningInstance () const =0

virtual void	OnPreInstall ()=0

virtual void	OnPostInstall (bool update, bool modal)=0

virtual void	OnPreUnInstall ()=0

virtual void	OnPostUnInstall ()=0

Constructor & Destructor Documentation

◆ ~IAddon()

virtual ADDON::IAddon::~IAddon ( )

virtualdefault

Member Function Documentation

◆ Art()

virtual ArtMap ADDON::IAddon::Art ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ Author()

virtual std::string ADDON::IAddon::Author ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ CanHaveAddonOrInstanceSettings()

virtual bool ADDON::IAddon::CanHaveAddonOrInstanceSettings ( )

pure virtual

Implemented in ADDON::CAddon, and KODI::GAME::CController.

◆ ChangeLog()

virtual std::string ADDON::IAddon::ChangeLog ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ DeleteInstanceSettings()

virtual bool ADDON::IAddon::DeleteInstanceSettings ( AddonInstanceId instance )

pure virtual

Implemented in ADDON::CAddon.

◆ Description()

virtual std::string ADDON::IAddon::Description ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ Disclaimer()

virtual std::string ADDON::IAddon::Disclaimer ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ ExtraInfo()

virtual const InfoMap & ADDON::IAddon::ExtraInfo ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ FanArt()

virtual std::string ADDON::IAddon::FanArt ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ GetDependencies()

virtual const std::vector< DependencyInfo > & ADDON::IAddon::GetDependencies ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ GetDependencyVersion()

virtual CAddonVersion ADDON::IAddon::GetDependencyVersion ( const std::string & dependencyID ) const

pure virtual

Implemented in ADDON::CAddon.

◆ GetKnownInstanceIds()

virtual std::vector< AddonInstanceId > ADDON::IAddon::GetKnownInstanceIds ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ GetRunningInstance()

virtual AddonPtr ADDON::IAddon::GetRunningInstance ( ) const

pure virtual

Implemented in ADDON::CAddon, ADDON::CAddonDll, and KODI::GAME::CGameClient.

◆ GetSetting()

virtual std::string ADDON::IAddon::GetSetting	(	const std::string &	key,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ GetSettingBool()

virtual bool ADDON::IAddon::GetSettingBool	(	const std::string &	key,
		bool &	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ GetSettingInt()

virtual bool ADDON::IAddon::GetSettingInt	(	const std::string &	key,
		int &	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ GetSettingNumber()

virtual bool ADDON::IAddon::GetSettingNumber	(	const std::string &	key,
		double &	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ GetSettings()

virtual std::shared_ptr< CAddonSettings > ADDON::IAddon::GetSettings ( AddonInstanceId id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ GetSettingString()

virtual bool ADDON::IAddon::GetSettingString	(	const std::string &	key,
		std::string &	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ HasMainType()

virtual bool ADDON::IAddon::HasMainType ( AddonType type ) const

pure virtual

Implemented in ADDON::CAddon.

◆ HasSettings()

virtual bool ADDON::IAddon::HasSettings ( AddonInstanceId id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon, and ADDON::CSkinInfo.

◆ HasType()

virtual bool ADDON::IAddon::HasType ( AddonType type ) const

pure virtual

Implemented in ADDON::CAddon, and ADDON::CPluginSource.

◆ HasUserSettings()

virtual bool ADDON::IAddon::HasUserSettings ( AddonInstanceId id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon, and ADDON::CSkinInfo.

◆ Icon()

virtual std::string ADDON::IAddon::Icon ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ ID()

virtual std::string ADDON::IAddon::ID ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ InstallDate()

virtual CDateTime ADDON::IAddon::InstallDate ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ InstanceUseType()

virtual AddonInstanceSupport ADDON::IAddon::InstanceUseType ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ IsBinary()

virtual bool ADDON::IAddon::IsBinary ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ IsInUse()

virtual bool ADDON::IAddon::IsInUse ( ) const

pure virtual

Implemented in ADDON::CAddon, ADDON::CAddonDll, ADDON::CLanguageResource, ADDON::CScraper, ADDON::CSkinInfo, and ADDON::CUISoundsResource.

◆ LastUpdated()

virtual CDateTime ADDON::IAddon::LastUpdated ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ LastUsed()

virtual CDateTime ADDON::IAddon::LastUsed ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ LibPath()

virtual std::string ADDON::IAddon::LibPath ( ) const

pure virtual

Implemented in ADDON::CAddon, ADDON::CAddonDll, and KODI::GAME::CGameClient.

◆ LifecycleState()

virtual AddonLifecycleState ADDON::IAddon::LifecycleState ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ LifecycleStateDescription()

virtual std::string ADDON::IAddon::LifecycleStateDescription ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ MainType()

virtual AddonType ADDON::IAddon::MainType ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ MeetsVersion()

virtual bool ADDON::IAddon::MeetsVersion	(	const CAddonVersion &	versionMin,
		const CAddonVersion &	version ) const

pure virtual

Implemented in ADDON::CAddon.

◆ MinVersion()

virtual CAddonVersion ADDON::IAddon::MinVersion ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ Name()

virtual std::string ADDON::IAddon::Name ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ OnPostInstall()

virtual void ADDON::IAddon::OnPostInstall	(	bool	update,
		bool	modal )

pure virtual

Implemented in ADDON::CAddon, ADDON::CAddonDll, ADDON::CFontResource, ADDON::CLanguageResource, ADDON::CSkinInfo, and ADDON::CUISoundsResource.

◆ OnPostUnInstall()

virtual void ADDON::IAddon::OnPostUnInstall ( )

pure virtual

Implemented in ADDON::CAddon, and ADDON::CAddonDll.

◆ OnPreInstall()

virtual void ADDON::IAddon::OnPreInstall ( )

pure virtual

Implemented in ADDON::CAddon, ADDON::CAddonDll, and ADDON::CSkinInfo.

◆ OnPreUnInstall()

virtual void ADDON::IAddon::OnPreUnInstall ( )

pure virtual

Implemented in ADDON::CAddon, ADDON::CAddonDll, and ADDON::CImageResource.

◆ Origin()

virtual std::string ADDON::IAddon::Origin ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ OriginName()

virtual std::string ADDON::IAddon::OriginName ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ PackageSize()

virtual uint64_t ADDON::IAddon::PackageSize ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ Path()

virtual std::string ADDON::IAddon::Path ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ Profile()

virtual std::string ADDON::IAddon::Profile ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ ReloadSettings()

virtual bool ADDON::IAddon::ReloadSettings ( AddonInstanceId id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ ResetSettings()

virtual void ADDON::IAddon::ResetSettings ( AddonInstanceId id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ SaveSettings()

virtual bool ADDON::IAddon::SaveSettings ( AddonInstanceId id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon, and ADDON::CAddonDll.

◆ Screenshots()

virtual std::vector< std::string > ADDON::IAddon::Screenshots ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ Summary()

virtual std::string ADDON::IAddon::Summary ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ SupportsInstanceSettings()

virtual bool ADDON::IAddon::SupportsInstanceSettings ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ SupportsMultipleInstances()

virtual bool ADDON::IAddon::SupportsMultipleInstances ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ Type()

virtual AddonType ADDON::IAddon::Type ( ) const

pure virtual

Implemented in ADDON::CAddon.

◆ UpdateSetting()

virtual void ADDON::IAddon::UpdateSetting	(	const std::string &	key,
		const std::string &	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ UpdateSettingBool()

virtual bool ADDON::IAddon::UpdateSettingBool	(	const std::string &	key,
		bool	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ UpdateSettingInt()

virtual bool ADDON::IAddon::UpdateSettingInt	(	const std::string &	key,
		int	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ UpdateSettingNumber()

virtual bool ADDON::IAddon::UpdateSettingNumber	(	const std::string &	key,
		double	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ UpdateSettingString()

virtual bool ADDON::IAddon::UpdateSettingString	(	const std::string &	key,
		const std::string &	value,
		AddonInstanceId	id = ADDON_SETTINGS_ID )

pure virtual

Implemented in ADDON::CAddon.

◆ Version()

virtual CAddonVersion ADDON::IAddon::Version ( ) const

pure virtual

Implemented in ADDON::CAddon.

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

IAddon.h

Public Member Functions

Constructor & Destructor Documentation

◆ ~IAddon()

Member Function Documentation

◆ Art()

◆ Author()

◆ CanHaveAddonOrInstanceSettings()

◆ ChangeLog()

◆ DeleteInstanceSettings()

◆ Description()

◆ Disclaimer()

◆ ExtraInfo()

◆ FanArt()

◆ GetDependencies()

◆ GetDependencyVersion()

◆ GetKnownInstanceIds()

◆ GetRunningInstance()

◆ GetSetting()

◆ GetSettingBool()

◆ GetSettingInt()

◆ GetSettingNumber()

◆ GetSettings()

◆ GetSettingString()

◆ HasMainType()

◆ HasSettings()

◆ HasType()

◆ HasUserSettings()

◆ Icon()

◆ ID()

◆ InstallDate()

◆ InstanceUseType()

◆ IsBinary()

◆ IsInUse()

◆ LastUpdated()

◆ LastUsed()

◆ LibPath()

◆ LifecycleState()

◆ LifecycleStateDescription()

◆ MainType()

◆ MeetsVersion()

◆ MinVersion()

◆ Name()

◆ OnPostInstall()

◆ OnPostUnInstall()

◆ OnPreInstall()

◆ OnPreUnInstall()

◆ Origin()

◆ OriginName()

◆ PackageSize()

◆ Path()

◆ Profile()

◆ ReloadSettings()

◆ ResetSettings()

◆ SaveSettings()

◆ Screenshots()

◆ Summary()

◆ SupportsInstanceSettings()

◆ SupportsMultipleInstances()

◆ Type()

◆ UpdateSetting()

◆ UpdateSettingBool()

◆ UpdateSettingInt()

◆ UpdateSettingNumber()

◆ UpdateSettingString()

◆ Version()