Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CFavouritesService Class Reference

#include <FavouritesService.h>

Classes

struct  FavouritesUpdated
 

Public Member Functions

 CFavouritesService (std::string userDataFolder)
 
virtual ~CFavouritesService ()=default
 
void ReInit (std::string userDataFolder)
 
bool IsFavourited (const CFileItem &item, int contextWindow) const
 
std::shared_ptr< CFileItemGetFavourite (const CFileItem &item, int contextWindow) const
 
std::shared_ptr< CFileItemResolveFavourite (const CFileItem &favItem) const
 
int Size () const
 
void GetAll (CFileItemList &items) const
 
bool AddOrRemove (const CFileItem &item, int contextWindow)
 
bool Save (const CFileItemList &items)
 
void RefreshFavourites ()
 Refresh favourites for directory providers, e.g. the GUI needs to be updated.
 
CEventStream< FavouritesUpdated > & Events ()
 

Constructor & Destructor Documentation

◆ CFavouritesService()

CFavouritesService::CFavouritesService ( std::string userDataFolder)
explicit

◆ ~CFavouritesService()

virtual CFavouritesService::~CFavouritesService ( )
virtualdefault

Member Function Documentation

◆ AddOrRemove()

bool CFavouritesService::AddOrRemove ( const CFileItem & item,
int contextWindow )

◆ Events()

CEventStream< FavouritesUpdated > & CFavouritesService::Events ( )
inline

◆ GetAll()

void CFavouritesService::GetAll ( CFileItemList & items) const

◆ GetFavourite()

std::shared_ptr< CFileItem > CFavouritesService::GetFavourite ( const CFileItem & item,
int contextWindow ) const

◆ IsFavourited()

bool CFavouritesService::IsFavourited ( const CFileItem & item,
int contextWindow ) const

◆ RefreshFavourites()

void CFavouritesService::RefreshFavourites ( )

Refresh favourites for directory providers, e.g. the GUI needs to be updated.

◆ ReInit()

void CFavouritesService::ReInit ( std::string userDataFolder)

For profiles

◆ ResolveFavourite()

std::shared_ptr< CFileItem > CFavouritesService::ResolveFavourite ( const CFileItem & favItem) const

◆ Save()

bool CFavouritesService::Save ( const CFileItemList & items)

◆ Size()

int CFavouritesService::Size ( ) const

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