libquentier 0.8.0
The library for rich desktop clients of Evernote service
Loading...
Searching...
No Matches
Public Member Functions | List of all members
quentier::synchronization::ISyncOptions Class Referenceabstract

Options for synchronization process. More...

#include <ISyncOptions.h>

Inheritance diagram for quentier::synchronization::ISyncOptions:
Inheritance graph
[legend]
Collaboration diagram for quentier::synchronization::ISyncOptions:
Collaboration graph
[legend]

Public Member Functions

virtual bool downloadNoteThumbnails () const =0
 
virtual std::optional< QDirinkNoteImagesStorageDir () const =0
 
virtual qevercloud::IRequestContextPtr requestContext () const =0
 
virtual qevercloud::IRetryPolicyPtr retryPolicy () const =0
 
virtual std::optional< quint32maxConcurrentNoteDownloads () const =0
 
virtual std::optional< quint32maxConcurrentResourceDownloads () const =0
 
- Public Member Functions inherited from quentier::Printable
virtual QTextStreamprint (QTextStream &strm) const =0
 
QString toString () const
 

Detailed Description

Options for synchronization process.

Member Function Documentation

◆ downloadNoteThumbnails()

virtual bool quentier::synchronization::ISyncOptions::downloadNoteThumbnails ( ) const
pure virtual

Flag to enable or disable downloading of note thumbnails during the sync. Note thumbnails are stored inside the local storage along with other note data.

◆ inkNoteImagesStorageDir()

virtual std::optional< QDir > quentier::synchronization::ISyncOptions::inkNoteImagesStorageDir ( ) const
pure virtual

Directory to store the downloaded ink note images. If this method returns std::nullopt, ink note images would not be downloaded during the sync.

Ink notes images data is stored inside note's resources but the format of the data is not documented, which makes it quite hard to implement note editor able to fully handle ink notes. An easier option is to visualize a static image corresponding to the last revision of the ink note. Such images need to be downloaded separately during the sync if they are required.

Ink note images are stored right in this directory without any subdirectories, file names correspond to pattern <resource guid>.png.

◆ maxConcurrentNoteDownloads()

virtual std::optional< quint32 > quentier::synchronization::ISyncOptions::maxConcurrentNoteDownloads ( ) const
pure virtual

Maximal number of concurrent note downloads. Allowing unlimited concurrent note downloads can lead to errors due to reaching the platform's limit on the number of open files. If std::nullopt is returned, the default limit is used.

◆ maxConcurrentResourceDownloads()

virtual std::optional< quint32 > quentier::synchronization::ISyncOptions::maxConcurrentResourceDownloads ( ) const
pure virtual

Maximal number of concurrent resource downloads. Allowing unlimited concurrent resource downloads can lead to errors due to reaching the platform's limit on the number of open files. If std::nullopt is returned, the default limit is used.

◆ requestContext()

virtual qevercloud::IRequestContextPtr quentier::synchronization::ISyncOptions::requestContext ( ) const
pure virtual

Request context with settings which should be used during the sync. If nullptr then request context with default settings would be used.

◆ retryPolicy()

virtual qevercloud::IRetryPolicyPtr quentier::synchronization::ISyncOptions::retryPolicy ( ) const
pure virtual

Retry policy which should be used during the sync. If nullptr then the default retry policy would be used.