Video library job implementation for marking items as watched/unwatched. More...

#include <VideoLibraryMarkWatchedJob.h>

Inheritance diagram for CVideoLibraryMarkWatchedJob:

Public Member Functions
	CVideoLibraryMarkWatchedJob (const std::shared_ptr< CFileItem > &item, bool mark)
	Creates a new video library scanning job.

	~CVideoLibraryMarkWatchedJob () override

const char *	GetType () const override
	Function that returns the type of job.

bool	operator== (const CJob *job) const override

Public Member Functions inherited from CVideoLibraryJob
	~CVideoLibraryJob () override

virtual bool	CanBeCancelled () const
	Whether the job can be cancelled or not.

virtual bool	Cancel ()
	Tries to cancel the running job.

bool	DoWork () override
	Main workhorse function of CJob instances.

Public Member Functions inherited from CJob
	CJob ()

virtual	~CJob ()=default
	Destructor for job objects.

virtual bool	ShouldCancel (unsigned int progress, unsigned int total) const
	Function for longer jobs to report progress and check whether they have been cancelled.

Protected Member Functions
bool	Work (CVideoDatabase &db) override
	Worker method to be implemented by an actual implementation.

Protected Member Functions inherited from CVideoLibraryJob
	CVideoLibraryJob ()

Additional Inherited Members
Public Types inherited from CJob
enum	PRIORITY { PRIORITY_LOW_PAUSABLE = 0 , PRIORITY_LOW , PRIORITY_NORMAL , PRIORITY_HIGH , PRIORITY_DEDICATED }
	Priority levels for jobs, specified by clients when adding jobs to the CJobManager. More...

Detailed Description

Video library job implementation for marking items as watched/unwatched.

Constructor & Destructor Documentation

◆ CVideoLibraryMarkWatchedJob()

CVideoLibraryMarkWatchedJob::CVideoLibraryMarkWatchedJob	(	const std::shared_ptr< CFileItem > &	item,
		bool	mark )

Creates a new video library scanning job.

Parameters

[in]	item	Item to be marked as watched/unwatched
[in]	mark	Whether to mark the item as watched or unwatched

◆ ~CVideoLibraryMarkWatchedJob()

CVideoLibraryMarkWatchedJob::~CVideoLibraryMarkWatchedJob ( )

overridedefault

Member Function Documentation

◆ GetType()

const char * CVideoLibraryMarkWatchedJob::GetType ( ) const

inlineoverridevirtual

Function that returns the type of job.

CJob subclasses may optionally implement this function to specify the type of job. This is useful for the CJobManager::AddLIFOJob() routine, which preempts similar jobs with the new job.

Returns: a unique character string describing the job.

See also: CJobManager

Reimplemented from CVideoLibraryJob.

◆ operator==()

bool CVideoLibraryMarkWatchedJob::operator== ( const CJob * job ) const

overridevirtual

Reimplemented from CVideoLibraryJob.

◆ Work()

bool CVideoLibraryMarkWatchedJob::Work ( CVideoDatabase & db )

overrideprotectedvirtual

Worker method to be implemented by an actual implementation.

Parameters

[in] db Already open video database to be used for interaction

Returns: True if the process succeeded, false otherwise

Implements CVideoLibraryJob.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members