QEverCloud  6.1.0
Unofficial Evernote Cloud API for Qt
Public Types | Public Member Functions | Public Attributes | Properties | List of all members
qevercloud::LazyMap Struct Reference

#include <Types.h>

Inheritance diagram for qevercloud::LazyMap:
qevercloud::Printable

Public Types

using FullMap = QMap< QString, QString >
 

Public Member Functions

virtual void print (QTextStream &strm) const override
 
bool operator== (const LazyMap &other) const
 
bool operator!= (const LazyMap &other) const
 
- Public Member Functions inherited from qevercloud::Printable
 Printable ()=default
 
virtual ~Printable ()=default
 
virtual QString toString () const
 

Public Attributes

EverCloudLocalData localData
 
Optional< QSet< QString > > keysOnly
 
Optional< QMap< QString, QString > > fullMap
 

Properties

Optional QSet
 
Optional< FullMapfullMap
 

Detailed Description

A structure that wraps a map of name/value pairs whose values are not always present in the structure in order to reduce space when obtaining batches of entities that contain the map.

When the server provides the client with a LazyMap, it will fill in either the keysOnly field or the fullMap field, but never both, based on the API and parameters.

When a client provides a LazyMap to the server as part of an update to an object, the server will only update the LazyMap if the fullMap field is set. If the fullMap field is not set, the server will not make any changes to the map.

Check the API documentation of the individual calls involving the LazyMap for full details including the constraints of the names and values of the map.

Member Typedef Documentation

◆ FullMap

using qevercloud::LazyMap::FullMap = QMap<QString, QString>

Member Function Documentation

◆ operator!=()

bool qevercloud::LazyMap::operator!= ( const LazyMap other) const
inline

◆ operator==()

bool qevercloud::LazyMap::operator== ( const LazyMap other) const
inline

◆ print()

virtual void qevercloud::LazyMap::print ( QTextStream &  strm) const
overridevirtual

Implements qevercloud::Printable.

Member Data Documentation

◆ fullMap

Optional<QMap<QString, QString> > qevercloud::LazyMap::fullMap

The complete map, including all keys and values.

◆ keysOnly

Optional<QSet<QString> > qevercloud::LazyMap::keysOnly

The set of keys for the map. This field is ignored by the server when set.

◆ localData

EverCloudLocalData qevercloud::LazyMap::localData

See the declaration of EverCloudLocalData for details

Property Documentation

◆ fullMap

Optional<FullMap> qevercloud::LazyMap::fullMap

◆ QSet

Optional qevercloud::LazyMap::QSet