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

#include <Types.h>

Inheritance diagram for qevercloud::Notebook:
qevercloud::Printable

Public Member Functions

virtual void print (QTextStream &strm) const override
 
bool operator== (const Notebook &other) const
 
bool operator!= (const Notebook &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 > name
 
Optional< qint32 > updateSequenceNum
 
Optional< bool > defaultNotebook
 
Optional< TimestampserviceCreated
 
Optional< TimestampserviceUpdated
 
Optional< Publishingpublishing
 
Optional< bool > published
 
Optional< QString > stack
 
Optional< QList< qint64 > > sharedNotebookIds
 
Optional< QList< SharedNotebook > > sharedNotebooks
 
Optional< BusinessNotebookbusinessNotebook
 
Optional< Usercontact
 
Optional< NotebookRestrictionsrestrictions
 
Optional< NotebookRecipientSettingsrecipientSettings
 

Properties

Optional QList
 

Detailed Description

A unique container for a set of notes.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ businessNotebook

Optional< BusinessNotebook > qevercloud::Notebook::businessNotebook

If the notebook is part of a business account and has been shared with the entire business, this will contain sharing information. The presence or absence of this field is not a reliable test of whether a given notebook is in fact a business notebook - the field is only used when a notebook is or has been shared with the entire business.

◆ contact

Optional< User > qevercloud::Notebook::contact

Intended for use with Business accounts, this field identifies the user who has been designated as the "contact". For notebooks created in business accounts, the server will automatically set this value to the user who created the notebook unless Notebook.contact.username has been set, in which that value will be used. When updating a notebook, it is common to leave Notebook.contact field unset, indicating that no change to the value is being requested and that the existing value, if any, should be preserved.

◆ defaultNotebook

Optional< bool > qevercloud::Notebook::defaultNotebook

If true, this notebook should be used for new notes whenever the user has not (or cannot) specify a desired target notebook. For example, if a note is submitted via SMTP email. The service will maintain at most one defaultNotebook per account. If a second notebook is created or updated with defaultNotebook set to true, the service will automatically update the prior notebook's defaultNotebook field to false. If the default notebook is deleted (i.e. "active" set to false), the "defaultNotebook" field will be set to false by the service. If the account has no default notebook set, the service will use the most recent notebook as the default.

◆ guid

Optional< Guid > qevercloud::Notebook::guid

The unique identifier of this notebook.
Length: EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
Regex: EDAM_GUID_REGEX

◆ localData

EverCloudLocalData qevercloud::Notebook::localData

See the declaration of EverCloudLocalData for details

◆ name

Optional< QString > qevercloud::Notebook::name

A sequence of characters representing the name of the notebook. May be changed by clients, but the account may not contain two notebooks with names that are equal via a case-insensitive comparison. Can't begin or end with a space.
Length: EDAM_NOTEBOOK_NAME_LEN_MIN - EDAM_NOTEBOOK_NAME_LEN_MAX
Regex: EDAM_NOTEBOOK_NAME_REGEX

◆ published

Optional< bool > qevercloud::Notebook::published

If this is set to true, then the Notebook will be accessible either to the public, or for business users to their business, via the 'publishing' or 'businessNotebook' specifications, which must also be set. If this is set to false, the Notebook will not be available to the public (or business). Clients that do not wish to change the publishing behavior of a Notebook should not set this value when calling NoteStore.updateNotebook().

◆ publishing

Optional< Publishing > qevercloud::Notebook::publishing

If the Notebook has been opened for public access, then this will point to the set of publishing information for the Notebook (URI, description, etc.). A Notebook cannot be published without providing this information, but it will persist for later use if publishing is ever disabled on the Notebook. Clients that do not wish to change the publishing behavior of a Notebook should not set this value when calling NoteStore.updateNotebook(). Note that this structure is never populated for business notebooks, see the businessNotebook field.

◆ recipientSettings

Optional< NotebookRecipientSettings > qevercloud::Notebook::recipientSettings

This represents the preferences/settings that a recipient has set for this notebook. These are intended to be changed only by the recipient, and each recipient has their own recipient settings.

◆ restrictions

Optional< NotebookRestrictions > qevercloud::Notebook::restrictions

NOT DOCUMENTED

◆ serviceCreated

Optional< Timestamp > qevercloud::Notebook::serviceCreated

The time when this notebook was created on the service. This will be set on the service during creation, and the service will provide this value when it returns a Notebook to a client. The service will ignore this value if it is sent by clients.

◆ serviceUpdated

Optional< Timestamp > qevercloud::Notebook::serviceUpdated

The time when this notebook was last modified on the service. This will be set on the service during creation, and the service will provide this value when it returns a Notebook to a client. The service will ignore this value if it is sent by clients.

◆ sharedNotebookIds

Optional<QList<qint64> > qevercloud::Notebook::sharedNotebookIds

DEPRECATED - replaced by sharedNotebooks.

◆ sharedNotebooks

Optional<QList<SharedNotebook> > qevercloud::Notebook::sharedNotebooks

The list of recipients to whom this notebook has been shared (one SharedNotebook object per recipient email address). This field will be unset if you do not have permission to access this data. If you are accessing the notebook as the owner or via a shared notebook that is modifiable, then you have access to this data and the value will be set. This field is read-only. Clients may not make changes to shared notebooks via this field.

◆ stack

Optional< QString > qevercloud::Notebook::stack

If this is set, then the notebook is visually contained within a stack of notebooks with this name. All notebooks in the same account with the same 'stack' field are considered to be in the same stack. Notebooks with no stack set are "top level" and not contained within a stack.

◆ updateSequenceNum

Optional< qint32 > qevercloud::Notebook::updateSequenceNum

A number identifying the last transaction to modify the state of this object. The USN values are sequential within an account, and can be used to compare the order of modifications within the service.

Property Documentation

◆ QList

Optional qevercloud::Notebook::QList