LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Media::IEventsProvider Class Referenceabstract

Interface for plugins that can provide events. More...

#include "ieventsprovider.h"

Public Member Functions

virtual ~IEventsProvider ()
 
virtual QString GetServiceName () const =0
 Returns the service name. More...
 
virtual void UpdateRecommendedEvents ()=0
 Requests re-fetching the list of recommended events. More...
 
virtual void AttendEvent (qint64 id, EventAttendType status)=0
 Updates the event attendance status, if possible. More...
 

Protected Member Functions

virtual void gotRecommendedEvents (const EventInfos_t &events)=0
 Emitted when a list of recommended events is fetched. More...
 

Detailed Description

Interface for plugins that can provide events.

Plugins that can provide nearby or recommended events based on user's location or musical taste should implement this interface.

Fetching recommended events is asynchronous in nature, so one should request updating the list of recommended events via UpdateRecommendedEvents() and then listen for the gotRecommendedEvents() signal.

Definition at line 162 of file ieventsprovider.h.

Constructor & Destructor Documentation

virtual Media::IEventsProvider::~IEventsProvider ( )
inlinevirtual

Definition at line 165 of file ieventsprovider.h.

Member Function Documentation

virtual void Media::IEventsProvider::AttendEvent ( qint64  id,
EventAttendType  status 
)
pure virtual

Updates the event attendance status, if possible.

This function marks the event attendance status as status, if the service supports it. The event is identified by its ID.

Parameters
[in]idThe ID of the event (EventInfo::ID_).
[in]statusThe new event attendance status.
virtual QString Media::IEventsProvider::GetServiceName ( ) const
pure virtual

Returns the service name.

This string returns a human-readable string with the service name, like "Last.FM".

Returns
The human-readable service name.
virtual void Media::IEventsProvider::gotRecommendedEvents ( const EventInfos_t events)
protectedpure virtual

Emitted when a list of recommended events is fetched.

Parameters
[out]eventsThe current list of recommended events.
virtual void Media::IEventsProvider::UpdateRecommendedEvents ( )
pure virtual

Requests re-fetching the list of recommended events.

The gotRecommendedEvents() signal will be emitted after new recommended events are fetched.

See Also
gotRecommendedEvents().

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