Ring Daemon 16.0.0
Loading...
Searching...
No Matches
jami::PreferenceServicesManager Class Reference

This class provides the interface between PreferenceHandlers and per account preferences. More...

#include <preferenceservicesmanager.h>

Collaboration diagram for jami::PreferenceServicesManager:
Collaboration graph

Public Member Functions

std::map< std::string, std::string > getHandlerDetails (const std::string &preferenceHandlerIdStr) const
 Returns details Map from s implementation.
 
std::vector< std::string > getHandlers () const
 List all PreferenceHandlers available.
 
 NON_COPYABLE (PreferenceServicesManager)
 
 PreferenceServicesManager (PluginManager &pluginManager)
 Constructor registers PreferenceHandler API services to the PluginManager instance.
 
void resetPreferences (const std::string &rootPath, const std::string &accountId)
 Resets acc preferences to default values.
 
bool setPreference (const std::string &key, const std::string &value, const std::string &rootPath, const std::string &accountId)
 Sets a preference.
 
 ~PreferenceServicesManager ()
 

Detailed Description

This class provides the interface between PreferenceHandlers and per account preferences.

Besides, it stores pointers to all loaded PreferenceHandlers;

Definition at line 39 of file preferenceservicesmanager.h.

Constructor & Destructor Documentation

◆ PreferenceServicesManager()

jami::PreferenceServicesManager::PreferenceServicesManager ( PluginManager pluginManager)

Constructor registers PreferenceHandler API services to the PluginManager instance.

These services will store PreferenceHandler pointers or clean them from the Plugin System once a plugin is loaded or unloaded.

Parameters
pluginManager

Definition at line 30 of file preferenceservicesmanager.cpp.

References jami::emitSignal().

Here is the call graph for this function:

◆ ~PreferenceServicesManager()

jami::PreferenceServicesManager::~PreferenceServicesManager ( )

Definition at line 35 of file preferenceservicesmanager.cpp.

Member Function Documentation

◆ getHandlerDetails()

std::map< std::string, std::string > jami::PreferenceServicesManager::getHandlerDetails ( const std::string &  preferenceHandlerIdStr) const

Returns details Map from s implementation.

Parameters
preferenceHandlerIdStr
Returns
Details map from the PreferenceHandler implementation

Definition at line 52 of file preferenceservicesmanager.cpp.

References jami::emitSignal().

Here is the call graph for this function:

◆ getHandlers()

std::vector< std::string > jami::PreferenceServicesManager::getHandlers ( ) const

List all PreferenceHandlers available.

Returns
Vector with stored PreferenceHandlers pointers.

Definition at line 41 of file preferenceservicesmanager.cpp.

References jami::emitSignal().

Here is the call graph for this function:

◆ NON_COPYABLE()

jami::PreferenceServicesManager::NON_COPYABLE ( PreferenceServicesManager  )

◆ resetPreferences()

void jami::PreferenceServicesManager::resetPreferences ( const std::string &  rootPath,
const std::string &  accountId 
)

Resets acc preferences to default values.

Parameters
rootPath
accountId

Definition at line 83 of file preferenceservicesmanager.cpp.

References jami::emitSignal().

Referenced by jami::JamiPluginManager::resetPluginPreferencesValuesMap().

Here is the call graph for this function:

◆ setPreference()

bool jami::PreferenceServicesManager::setPreference ( const std::string &  key,
const std::string &  value,
const std::string &  rootPath,
const std::string &  accountId 
)

Sets a preference.

Parameters
key
value
rootPath
accountId
Returns
False if preference was changed.

Definition at line 64 of file preferenceservicesmanager.cpp.

References jami::emitSignal().

Referenced by jami::JamiPluginManager::setPluginPreference().

Here is the call graph for this function:

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