libquentier 0.8.0
The library for rich desktop clients of Evernote service
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Friends | List of all members
quentier::local_storage::ILocalStorage Class Referenceabstract
Inheritance diagram for quentier::local_storage::ILocalStorage:
Inheritance graph
[legend]

Classes

struct  ListGuidsFilters
 
struct  ListLinkedNotebooksOptions
 
struct  ListNotebooksOptions
 
struct  ListNotesOptions
 
struct  ListObjectsFilters
 
struct  ListOptionsBase
 
struct  ListSavedSearchesOptions
 
struct  ListTagsOptions
 

Public Types

enum class  StartupOption { ClearDatabase = 1 << 1 , OverrideLock = 1 << 2 }
 
enum class  ListObjectsFilter { Include , Exclude }
 
enum class  OrderDirection { Ascending , Descending }
 
enum class  ListNotebooksOrder {
  NoOrder , ByUpdateSequenceNumber , ByNotebookName , ByCreationTimestamp ,
  ByModificationTimestamp
}
 
enum class  ListLinkedNotebooksOrder { NoOrder , ByUpdateSequenceNumber , ByShareName , ByUsername }
 
enum class  ListTagsOrder { NoOrder , ByUpdateSequenceNumber , ByName }
 
enum class  ListNotesOrder {
  NoOrder , ByUpdateSequenceNumber , ByTitle , ByCreationTimestamp ,
  ByModificationTimestamp , ByDeletionTimestamp , ByAuthor , BySource ,
  BySourceApplication , ByReminderTime , ByPlaceName
}
 
enum class  ListSavedSearchesOrder { NoOrder , ByUpdateSequenceNumber , ByName , ByFormat }
 
enum class  Affiliation { Any , User , AnyLinkedNotebook , ParticularLinkedNotebooks }
 
enum class  TagNotesRelation { Any , WithNotes , WithoutNotes }
 
enum class  NoteCountOption { IncludeNonDeletedNotes = 1 << 1 , IncludeDeletedNotes = 1 << 2 }
 
enum class  UpdateNoteOption { UpdateResourceMetadata = 1 << 1 , UpdateResourceBinaryData = 1 << 2 , UpdateTags = 1 << 3 }
 
enum class  FetchNoteOption { WithResourceMetadata = 1 << 1 , WithResourceBinaryData = 1 << 2 }
 
enum class  FetchResourceOption { WithBinaryData = 1 << 1 }
 
enum class  HighestUsnOption { WithinUserOwnContent , WithinUserOwnContentAndLinkedNotebooks }
 

Public Member Functions

 Q_DECLARE_FLAGS (StartupOptions, StartupOption)
 
virtual QFuture< bool > isVersionTooHigh () const =0
 
virtual QFuture< bool > requiresUpgrade () const =0
 
virtual QFuture< QList< IPatchPtr > > requiredPatches () const =0
 
virtual QFuture< qint32 > version () const =0
 
virtual QFuture< qint32 > highestSupportedVersion () const =0
 
virtual QFuture< quint32 > userCount () const =0
 
virtual QFuture< void > putUser (qevercloud::User user)=0
 
virtual QFuture< std::optional< qevercloud::User > > findUserById (qevercloud::UserID userId) const =0
 
virtual QFuture< void > expungeUserById (qevercloud::UserID userId)=0
 
virtual QFuture< quint32 > notebookCount () const =0
 
virtual QFuture< void > putNotebook (qevercloud::Notebook notebook)=0
 
virtual QFuture< std::optional< qevercloud::Notebook > > findNotebookByLocalId (QString notebookLocalId) const =0
 
virtual QFuture< std::optional< qevercloud::Notebook > > findNotebookByGuid (qevercloud::Guid guid) const =0
 
virtual QFuture< std::optional< qevercloud::Notebook > > findNotebookByName (QString notebookName, std::optional< qevercloud::Guid > linkedNotebookGuid=std::nullopt) const =0
 
virtual QFuture< std::optional< qevercloud::Notebook > > findDefaultNotebook () const =0
 
virtual QFuture< void > expungeNotebookByLocalId (QString notebookLocalId)=0
 
virtual QFuture< void > expungeNotebookByGuid (qevercloud::Guid notebookGuid)=0
 
virtual QFuture< void > expungeNotebookByName (QString name, std::optional< qevercloud::Guid > linkedNotebookGuid=std::nullopt)=0
 
virtual QFuture< QList< qevercloud::Notebook > > listNotebooks (ListNotebooksOptions options={}) const =0
 
virtual QFuture< QList< qevercloud::SharedNotebook > > listSharedNotebooks (qevercloud::Guid notebookGuid={}) const =0
 
virtual QFuture< QSet< qevercloud::Guid > > listNotebookGuids (ListGuidsFilters filters, std::optional< qevercloud::Guid > linkedNotebookGuid={}) const =0
 
virtual QFuture< quint32 > linkedNotebookCount () const =0
 
virtual QFuture< void > putLinkedNotebook (qevercloud::LinkedNotebook linkedNotebook)=0
 
virtual QFuture< std::optional< qevercloud::LinkedNotebook > > findLinkedNotebookByGuid (qevercloud::Guid guid) const =0
 
virtual QFuture< void > expungeLinkedNotebookByGuid (qevercloud::Guid guid)=0
 
virtual QFuture< QList< qevercloud::LinkedNotebook > > listLinkedNotebooks (ListLinkedNotebooksOptions options={}) const =0
 
virtual QFuture< quint32 > noteCount (NoteCountOptions options=NoteCountOptions(NoteCountOption::IncludeNonDeletedNotes)) const =0
 
virtual QFuture< quint32 > noteCountPerNotebookLocalId (QString notebookLocalId, NoteCountOptions options=NoteCountOptions(NoteCountOption::IncludeNonDeletedNotes)) const =0
 
virtual QFuture< quint32 > noteCountPerTagLocalId (QString tagLocalId, NoteCountOptions options=NoteCountOptions(NoteCountOption::IncludeNonDeletedNotes)) const =0
 
virtual QFuture< QHash< QString, quint32 > > noteCountsPerTags (ListTagsOptions listTagsOptions={}, NoteCountOptions options=NoteCountOptions(NoteCountOption::IncludeNonDeletedNotes)) const =0
 
virtual QFuture< quint32 > noteCountPerNotebookAndTagLocalIds (QStringList notebookLocalIds, QStringList tagLocalIds, NoteCountOptions options=NoteCountOptions(NoteCountOption::IncludeNonDeletedNotes)) const =0
 
virtual QFuture< void > putNote (qevercloud::Note note)=0
 
virtual QFuture< void > updateNote (qevercloud::Note note, UpdateNoteOptions options)=0
 
virtual QFuture< std::optional< qevercloud::Note > > findNoteByLocalId (QString noteLocalId, FetchNoteOptions options) const =0
 
virtual QFuture< std::optional< qevercloud::Note > > findNoteByGuid (qevercloud::Guid noteGuid, FetchNoteOptions options) const =0
 
virtual QFuture< QList< qevercloud::Note > > listNotes (FetchNoteOptions fetchOptions, ListNotesOptions listOptions={}) const =0
 
virtual QFuture< QList< qevercloud::Note > > listNotesPerNotebookLocalId (QString notebookLocalId, FetchNoteOptions fetchOptions, ListNotesOptions listOptions={}) const =0
 
virtual QFuture< QList< qevercloud::Note > > listNotesPerTagLocalId (QString tagLocalId, FetchNoteOptions fetchOptions, ListNotesOptions listOptions={}) const =0
 
virtual QFuture< QList< qevercloud::Note > > listNotesPerNotebookAndTagLocalIds (QStringList notebookLocalIds, QStringList tagLocalIds, FetchNoteOptions fetchOptions, ListNotesOptions listOptions={}) const =0
 
virtual QFuture< QList< qevercloud::Note > > listNotesByLocalIds (QStringList noteLocalIds, FetchNoteOptions fetchOptions, ListNotesOptions listOptions={}) const =0
 
virtual QFuture< QSet< qevercloud::Guid > > listNoteGuids (ListGuidsFilters filters, std::optional< qevercloud::Guid > linkedNotebookGuid={}) const =0
 
virtual QFuture< QList< qevercloud::Note > > queryNotes (NoteSearchQuery query, FetchNoteOptions fetchOptions) const =0
 
virtual QFuture< QStringList > queryNoteLocalIds (NoteSearchQuery query) const =0
 
virtual QFuture< void > expungeNoteByLocalId (QString noteLocalId)=0
 
virtual QFuture< void > expungeNoteByGuid (qevercloud::Guid noteGuid)=0
 
virtual QFuture< quint32 > tagCount () const =0
 
virtual QFuture< void > putTag (qevercloud::Tag tag)=0
 
virtual QFuture< std::optional< qevercloud::Tag > > findTagByLocalId (QString tagLocalId) const =0
 
virtual QFuture< std::optional< qevercloud::Tag > > findTagByGuid (qevercloud::Guid tagGuid) const =0
 
virtual QFuture< std::optional< qevercloud::Tag > > findTagByName (QString tagName, std::optional< qevercloud::Guid > linkedNotebookGuid=std::nullopt) const =0
 
virtual QFuture< QList< qevercloud::Tag > > listTags (ListTagsOptions options={}) const =0
 
virtual QFuture< QList< qevercloud::Tag > > listTagsPerNoteLocalId (QString noteLocalId, ListTagsOptions options={}) const =0
 
virtual QFuture< QSet< qevercloud::Guid > > listTagGuids (ListGuidsFilters filters, std::optional< qevercloud::Guid > linkedNotebookGuid={}) const =0
 
virtual QFuture< void > expungeTagByLocalId (QString tagLocalId)=0
 
virtual QFuture< void > expungeTagByGuid (qevercloud::Guid tagGuid)=0
 
virtual QFuture< void > expungeTagByName (QString name, std::optional< qevercloud::Guid > linkedNotebookGuid=std::nullopt)=0
 
virtual QFuture< quint32 > resourceCount (NoteCountOptions options=NoteCountOptions(NoteCountOption::IncludeNonDeletedNotes)) const =0
 
virtual QFuture< quint32 > resourceCountPerNoteLocalId (QString noteLocalId) const =0
 
virtual QFuture< void > putResource (qevercloud::Resource resource)=0
 
virtual QFuture< std::optional< qevercloud::Resource > > findResourceByLocalId (QString resourceLocalId, FetchResourceOptions options={}) const =0
 
virtual QFuture< std::optional< qevercloud::Resource > > findResourceByGuid (qevercloud::Guid resourceGuid, FetchResourceOptions options={}) const =0
 
virtual QFuture< void > expungeResourceByLocalId (QString resourceLocalId)=0
 
virtual QFuture< void > expungeResourceByGuid (qevercloud::Guid resourceGuid)=0
 
virtual QFuture< quint32 > savedSearchCount () const =0
 
virtual QFuture< void > putSavedSearch (qevercloud::SavedSearch search)=0
 
virtual QFuture< std::optional< qevercloud::SavedSearch > > findSavedSearchByLocalId (QString savedSearchLocalId) const =0
 
virtual QFuture< std::optional< qevercloud::SavedSearch > > findSavedSearchByGuid (qevercloud::Guid guid) const =0
 
virtual QFuture< std::optional< qevercloud::SavedSearch > > findSavedSearchByName (QString name) const =0
 
virtual QFuture< QList< qevercloud::SavedSearch > > listSavedSearches (ListSavedSearchesOptions options={}) const =0
 
virtual QFuture< QSet< qevercloud::Guid > > listSavedSearchGuids (ListGuidsFilters filters) const =0
 
virtual QFuture< void > expungeSavedSearchByLocalId (QString savedSearchLocalId)=0
 
virtual QFuture< void > expungeSavedSearchByGuid (qevercloud::Guid guid)=0
 
virtual QFuture< qint32 > highestUpdateSequenceNumber (HighestUsnOption option) const =0
 
virtual QFuture< qint32 > highestUpdateSequenceNumber (qevercloud::Guid linkedNotebookGuid) const =0
 
virtual ILocalStorageNotifier * notifier () const =0
 

Friends

QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, StartupOption option)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, StartupOption option)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, StartupOptions options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, StartupOptions options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, ListObjectsFilter filter)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, ListObjectsFilter filter)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, const ListObjectsFilters &filters)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, const ListObjectsFilters &filters)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, const ListGuidsFilters &filters)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, const ListGuidsFilters &filters)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, OrderDirection orderDirection)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, OrderDirection orderDirection)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, ListNotebooksOrder order)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, ListNotebooksOrder order)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, ListLinkedNotebooksOrder order)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, ListLinkedNotebooksOrder order)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, ListTagsOrder order)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, ListTagsOrder order)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, ListNotesOrder order)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, ListNotesOrder order)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, ListSavedSearchesOrder order)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, ListSavedSearchesOrder order)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, Affiliation affiliation)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, Affiliation affiliation)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, const ListNotebooksOptions &options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, const ListNotebooksOptions &options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, const ListLinkedNotebooksOptions &options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, const ListLinkedNotebooksOptions &options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, const ListSavedSearchesOptions &options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, const ListSavedSearchesOptions &options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, const ListNotesOptions &options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, const ListNotesOptions &options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, const ListTagsOptions &options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, const ListTagsOptions &options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, NoteCountOption option)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, NoteCountOption option)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, NoteCountOptions options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, NoteCountOptions options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, UpdateNoteOption option)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, UpdateNoteOption option)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, UpdateNoteOptions options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, UpdateNoteOptions options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, FetchNoteOption option)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, FetchNoteOption option)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, FetchNoteOptions options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, FetchNoteOptions options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, FetchResourceOption option)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, FetchResourceOption option)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, FetchResourceOptions options)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, FetchResourceOptions options)
 
QUENTIER_EXPORT QTextStream & operator<< (QTextStream &strm, HighestUsnOption option)
 
QUENTIER_EXPORT QDebug & operator<< (QDebug &dbg, HighestUsnOption option)
 

Member Enumeration Documentation

◆ Affiliation

enum class quentier::local_storage::ILocalStorage::Affiliation
strong

Denotes whether some data item belongs to user's own account, any of linked notebooks or particular linked notebooks

◆ TagNotesRelation

enum class quentier::local_storage::ILocalStorage::TagNotesRelation
strong

Denotes the relation between tag and notes - whether any note us using the given tag

Enumerator
Any 

The tag might be used by some notes or it might not be.

WithNotes 

The tag is used by some notes.

WithoutNotes 

The tag is not used by any note.

Member Function Documentation

◆ notifier()

virtual ILocalStorageNotifier * quentier::local_storage::ILocalStorage::notifier ( ) const
nodiscardpure virtual

Notifications about the events occurring with the local storage are done via signals emitted by ILocalStorageNotifier.

Returns
the pointer to ILocalStorageNotifier object which would be valid for at least as long as ILocalStorage object that returned it is alive.
Generated on Sun Jan 26 2025 00:00:00 for libquentier by doxygen 1.13.2