MythFrontendService Class Reference

#include <mythfrontend/services/mythfrontendservice.h>

Inheritance diagram for MythFrontendService:

Collaboration diagram for MythFrontendService:

Public Member Functions
	MythFrontendService ()
	~MythFrontendService () override=default
Public Member Functions inherited from MythHTTPService
	MythHTTPService (MythHTTPMetaService *MetaService)
	~MythHTTPService () override=default
virtual HTTPResponse	HTTPRequest (const HTTPRequest2 &Request)
	Respond to a valid HTTPRequest. More...
QString &	Name ()

Static Public Member Functions
static void	RegisterCustomTypes ()
Static Public Member Functions inherited from MythHTTPService
template<class T >
static HTTPServicePtr	Create ()

Static Protected Member Functions
static bool	IsValidAction (const QString &Action)

Static Private Member Functions
static Q_CLASSINFO("GetContextList", "name=StringList") public slots bool	SendKey (const QString &Key)
static FrontendActionList *	GetActionList (const QString &Context)
static QStringList	GetContextList ()
static FrontendStatus *	GetStatus ()
static bool	PlayVideo (const QString &Id, bool UseBookmark)
static bool	PlayRecording (int RecordedId, int ChanId, const QDateTime &StartTime)
static bool	SendMessage (const QString &Message, uint Timeout)
static bool	SendNotification (bool Error, const QString &Type, const QString &Message, const QString &Origin, const QString &Description, const QString &Image, const QString &Extra, const QString &ProgressText, float Progress, std::chrono::seconds Timeout, bool Fullscreen, uint Visibility, uint Priority)
	Send a notification to the frontend. More...

Additional Inherited Members
Protected Member Functions inherited from MythHTTPService
bool	HAS_PARAMv2 (const QString &p)
Protected Attributes inherited from MythHTTPService
QString	m_name
MythHTTPMetaService *	m_staticMetaService { nullptr }
HTTPRequest2	m_request {nullptr}

Detailed Description

Definition at line 48 of file mythfrontendservice.h.

Constructor & Destructor Documentation

MythFrontendService()

MythFrontendService::MythFrontendService

(

)

Definition at line 102 of file mythfrontendservice.cpp.

~MythFrontendService()

MythFrontendService::~MythFrontendService ( )

overridedefault

Member Function Documentation

SendKey()

bool MythFrontendService::SendKey ( const QString &  Key )

staticprivate

Definition at line 115 of file mythfrontendservice.cpp.

GetActionList()

FrontendActionList * MythFrontendService::GetActionList ( const QString &  Context )

staticprivate

Definition at line 192 of file mythfrontendservice.cpp.

GetContextList()

QStringList MythFrontendService::GetContextList ( )

staticprivate

Definition at line 214 of file mythfrontendservice.cpp.

GetStatus()

FrontendStatus * MythFrontendService::GetStatus ( )

staticprivate

Definition at line 107 of file mythfrontendservice.cpp.

PlayVideo()

bool MythFrontendService::PlayVideo ( const QString &  Id, bool  UseBookmark  )

staticprivate

Definition at line 320 of file mythfrontendservice.cpp.

PlayRecording()

bool MythFrontendService::PlayRecording ( int  RecordedId, int  ChanId, const QDateTime &  StartTime  )

staticprivate

Definition at line 260 of file mythfrontendservice.cpp.

SendMessage()

bool MythFrontendService::SendMessage ( const QString &  Message, uint  Timeout  )

staticprivate

Definition at line 159 of file mythfrontendservice.cpp.

SendNotification()

bool MythFrontendService::SendNotification ( bool  Error, const QString &  Type, const QString &  Message, const QString &  Origin, const QString &  Description, const QString &  Image, const QString &  Extra, const QString &  ProgressText, float  Progress, std::chrono::seconds  Timeout, bool  Fullscreen, uint  Visibility, uint  Priority  )

staticprivate

Send a notification to the frontend.

Note

Complete use of this method (i.e. using all available parameters) will probably not work as expected as Qt's invoke calls are limited to 10 parameters (one of which is the return type).

Definition at line 174 of file mythfrontendservice.cpp.

RegisterCustomTypes()

static void MythFrontendService::RegisterCustomTypes ( )

static

IsValidAction()

bool MythFrontendService::IsValidAction ( const QString &  Action )

staticprotected

Definition at line 252 of file mythfrontendservice.cpp.

---

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

• mythtv/programs/mythfrontend/services/mythfrontendservice.h
• mythtv/programs/mythfrontend/services/mythfrontendservice.cpp