LeechCraft 0.6.70-19214-g121e5318a7
Modular cross-platform feature rich live environment.
Loading...
Searching...
No Matches
Media::ITopProvider Class Referenceabstract

Interface for plugins that provide top charts. More...

#include "itopprovider.h"

Public Types

using TopArtistsResult_t = LC::Util::Either<QString, QList<TopArtistInfo>>
 The result of a top artists query.
using TopTracksResult_t = LC::Util::Either<QString, QList<TopTrackInfo>>
 The result of a top tracks query.

Public Member Functions

virtual ~ITopProvider ()
virtual QString GetServiceName () const =0
 Returns the service name.
virtual QFuture< TopArtistsResult_t > RequestTopArtists ()=0
 Requests the list of top artists.
virtual QFuture< TopTracksResult_t > RequestTopTracks ()=0
 Requests the list of top tracks.

Detailed Description

Interface for plugins that provide top charts.

Definition at line 117 of file itopprovider.h.

Member Typedef Documentation

◆ TopArtistsResult_t

The result of a top artists query.

Either a string with a human-readable error text, or the list of the top artists.

Definition at line 127 of file itopprovider.h.

◆ TopTracksResult_t

The result of a top tracks query.

Either a string with a human-readable error text, or the list of the top tracks.

Definition at line 134 of file itopprovider.h.

Constructor & Destructor Documentation

◆ ~ITopProvider()

virtual Media::ITopProvider::~ITopProvider ( )
inlinevirtual

Definition at line 120 of file itopprovider.h.

Member Function Documentation

◆ GetServiceName()

virtual QString Media::ITopProvider::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.

◆ RequestTopArtists()

virtual QFuture< TopArtistsResult_t > Media::ITopProvider::RequestTopArtists ( )
pure virtual

Requests the list of top artists.

Returns
The future holding the query result.

◆ RequestTopTracks()

virtual QFuture< TopTracksResult_t > Media::ITopProvider::RequestTopTracks ( )
pure virtual

Requests the list of top tracks.

Returns
The future holding the query result.

The documentation for this class was generated from the following file:
  • /home/abuild/rpmbuild/BUILD/leechcraft-doc-0.6.70+git.19214.g121e5318a7-build/leechcraft-0.6.70-19214-g121e5318a7/src/interfaces/media/itopprovider.h