ADDON::CBinaryAddonManager Class Reference

#include <BinaryAddonManager.h>

Public Member Functions
	CBinaryAddonManager ()
	CBinaryAddonManager (const CBinaryAddonManager &)=delete
	~CBinaryAddonManager ()
bool	Init ()
void	DeInit ()
bool	HasInstalledAddons (const TYPE &type) const
	Checks system about given type to know related add-on's are installed. More...
bool	HasEnabledAddons (const TYPE &type) const
	Checks system about given type to know related add-on's are installed and also minimum one enabled. More...
bool	IsAddonInstalled (const std::string &addonId, const TYPE &type=ADDON_UNKNOWN)
	Checks whether an addon is installed. More...
bool	IsAddonEnabled (const std::string &addonId, const TYPE &type=ADDON_UNKNOWN)
	Check whether an addon has been enabled. More...
void	GetAddonInfos (BinaryAddonBaseList &addonInfos, bool enabledOnly, const TYPE &type) const
	Get a list of add-on's with info's for the on system available ones. More...
void	GetDisabledAddonInfos (BinaryAddonBaseList &addonInfos, const TYPE &type)
	Get a list of disabled add-on's with info's for the on system available ones. More...
const BinaryAddonBasePtr	GetInstalledAddonInfo (const std::string &addonId, const TYPE &type=ADDON_UNKNOWN) const
	To get information from a installed add-on. More...
AddonPtr	GetRunningAddon (const std::string &addonId) const
	Used from other addon manager to get active addon over a from him created CAddonDll. More...
const std::string &	GetTempAddonBasePath ()
	To get the path where temporary addon parts can be becomes stored. More...

Constructor & Destructor Documentation

CBinaryAddonManager() [1/2]

CBinaryAddonManager::CBinaryAddonManager

(

)

CBinaryAddonManager() [2/2]

ADDON::CBinaryAddonManager::CBinaryAddonManager ( const CBinaryAddonManager &  )

delete

~CBinaryAddonManager()

CBinaryAddonManager::~CBinaryAddonManager

(

)

Member Function Documentation

DeInit()

void CBinaryAddonManager::DeInit

(

)

GetAddonInfos()

void CBinaryAddonManager::GetAddonInfos	(	BinaryAddonBaseList &	addonInfos,
		bool	enabledOnly,
		const TYPE &	type
	)		const

Get a list of add-on's with info's for the on system available ones.

Parameters

[out]	addonInfos	list where finded addon information becomes stored
[in]	enabledOnly	If true are only enabled ones given back, if false all on system available. Default is true.
[in]	type	The requested type, with "ADDON_UNKNOWN" are all add-on types given back who match the case with value before. If a type id becomes added are only add-ons returned who match them. Default is for all types.

GetDisabledAddonInfos()

void CBinaryAddonManager::GetDisabledAddonInfos	(	BinaryAddonBaseList &	addonInfos,
		const TYPE &	type
	)

Get a list of disabled add-on's with info's for the on system available ones.

Parameters

[out]	addonInfos	list where finded addon information becomes stored
[in]	type	The requested type, with "ADDON_UNKNOWN" are all add-on types given back who match the case with value before. If a type id becomes added are only add-ons returned who match them. Default is for all types.

GetInstalledAddonInfo()

const BinaryAddonBasePtr CBinaryAddonManager::GetInstalledAddonInfo	(	const std::string &	addonId,
		const TYPE &	type = ADDON_UNKNOWN
	)		const

To get information from a installed add-on.

Parameters

[in]	addonId	the add-on id to get the info for
[in]	type	if used becomes used type confirmed and is supported, if not a nullptr is returned

Returns

add-on information pointer of installed add-on

GetRunningAddon()

AddonPtr CBinaryAddonManager::GetRunningAddon

(

const std::string &

addonId

)

const

Used from other addon manager to get active addon over a from him created CAddonDll.

Parameters

[in]

addonId

related addon id string

Returns

if present the pointer to active one or nullptr if not present

GetTempAddonBasePath()

const std::string& ADDON::CBinaryAddonManager::GetTempAddonBasePath ( )

inline

To get the path where temporary addon parts can be becomes stored.

Returns

the base path used for temporary addon paths

Warning

the folder and his contents becomes deleted during stop and close of Kodi

HasEnabledAddons()

bool CBinaryAddonManager::HasEnabledAddons

(

const TYPE &

type

)

const

Checks system about given type to know related add-on's are installed and also minimum one enabled.

Parameters

[in]

type

Add-on type to check enabled

Returns

true if given type is enabled

HasInstalledAddons()

bool CBinaryAddonManager::HasInstalledAddons

(

const TYPE &

type

)

const

Checks system about given type to know related add-on's are installed.

Parameters

[in]

type

Add-on type to check installed

Returns

true if given type is installed

Init()

bool CBinaryAddonManager::Init

(

)

IsAddonEnabled()

bool CBinaryAddonManager::IsAddonEnabled	(	const std::string &	addonId,
		const TYPE &	type = ADDON_UNKNOWN
	)

Check whether an addon has been enabled.

Parameters

[in]	addonId	id of the addon
[in]	type	Add-on type to check installed and enabled

Returns

true if enabled

IsAddonInstalled()

bool CBinaryAddonManager::IsAddonInstalled	(	const std::string &	addonId,
		const TYPE &	type = ADDON_UNKNOWN
	)

Checks whether an addon is installed.

Parameters

[in]	addonId	id of the addon
[in]	type	Add-on type to check installed

Returns

true if installed

---

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

• BinaryAddonManager.h
• BinaryAddonManager.cpp