LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
Media::IRecentReleases Class Referenceabstract

Interface for plugins providing recent releases. More...

#include "irecentreleases.h"

Public Types

using Result_t = LC::Util::Either< QString, QList< AlbumRelease > >
 The result of a recent releases query. More...
 

Public Member Functions

virtual ~IRecentReleases ()
 
virtual QFuture< Result_tRequestRecentReleases (int number, bool withRecommends)=0
 Requests the recent releases. More...
 
virtual QString GetServiceName () const =0
 Returns the service name. More...
 

Detailed Description

Interface for plugins providing recent releases.

This interface should be implemented by plugins providing information about recent releases based on user's musical taste (like Last.FM's service).

Definition at line 61 of file irecentreleases.h.

Member Typedef Documentation

◆ Result_t

The result of a recent releases query.

The result of a recent releases query is either a string with a human-readable error text, or a list of AlbumRelease objects.

Definition at line 71 of file irecentreleases.h.

Constructor & Destructor Documentation

◆ ~IRecentReleases()

virtual Media::IRecentReleases::~IRecentReleases ( )
inlinevirtual

Definition at line 64 of file irecentreleases.h.

Member Function Documentation

◆ GetServiceName()

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

◆ RequestRecentReleases()

virtual QFuture<Result_t> Media::IRecentReleases::RequestRecentReleases ( int  number,
bool  withRecommends 
)
pure virtual

Requests the recent releases.

If withRecommends is set to false then only releases by the artists in the user's library should be fetched. Otherwise, the result set may include (or consist only of) releases that are recommended to the user (based on his musical taste, for example) but aren't directly related to artists in his library.

Parameters
[in]numberThe number of releases to get.
[in]withRecommendsWhether recommendations or releases from user's library should be fetched.
Returns
The future holding the recent releases query result.

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