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

#include <Types.h>

Inheritance diagram for qevercloud::NotebookDescriptor:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< Guidguid
 
Optional< QString > notebookDisplayName
 
Optional< QString > contactName
 
Optional< bool > hasSharedNotebook
 
Optional< qint32 > joinedUserCount
 

Detailed Description

A structure that describes a notebook or a user's relationship with a notebook. NotebookDescriptor is expected to remain a lighter-weight structure when compared to Notebook.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ contactName

Optional< QString > qevercloud::NotebookDescriptor::contactName

The User.name value of the notebook's "contact".

◆ guid

Optional< Guid > qevercloud::NotebookDescriptor::guid

The unique identifier of the notebook.

◆ hasSharedNotebook

Optional< bool > qevercloud::NotebookDescriptor::hasSharedNotebook

Whether a SharedNotebook record exists between the calling user and this notebook.

◆ joinedUserCount

Optional< qint32 > qevercloud::NotebookDescriptor::joinedUserCount

The number of users who have joined this notebook.

◆ localData

EverCloudLocalData qevercloud::NotebookDescriptor::localData

See the declaration of EverCloudLocalData for details

◆ notebookDisplayName

Optional< QString > qevercloud::NotebookDescriptor::notebookDisplayName

A sequence of characters representing the name of the notebook.