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

#include <Types.h>

Inheritance diagram for qevercloud::Publishing:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< QString > uri
 
Optional< NoteSortOrderorder
 
Optional< bool > ascending
 
Optional< QString > publicDescription
 

Detailed Description

If a Notebook has been opened to the public, the Notebook will have a reference to one of these structures, which gives the location and optional description of the externally-visible public Notebook.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ ascending

Optional< bool > qevercloud::Publishing::ascending

If this is set to true, then the public notes will be displayed in ascending order (e.g. from oldest to newest). Otherwise, the notes will be displayed in descending order (e.g. newest to oldest).

◆ localData

EverCloudLocalData qevercloud::Publishing::localData

See the declaration of EverCloudLocalData for details

◆ order

Optional< NoteSortOrder > qevercloud::Publishing::order

When the notes are publicly displayed, they will be sorted based on the requested criteria.

◆ publicDescription

Optional< QString > qevercloud::Publishing::publicDescription

This field may be used to provide a short description of the notebook, which may be displayed when (e.g.) the notebook is shown in a public view. Can't begin or end with a space.
Length: EDAM_PUBLISHING_DESCRIPTION_LEN_MIN - EDAM_PUBLISHING_DESCRIPTION_LEN_MAX
Regex: EDAM_PUBLISHING_DESCRIPTION_REGEX

◆ uri

Optional< QString > qevercloud::Publishing::uri

If this field is present, then the notebook is published for mass consumption on the Internet under the provided URI, which is relative to a defined base publishing URI defined by the service. This field can only be modified via the web service GUI ... publishing cannot be modified via an offline client.
Length: EDAM_PUBLISHING_URI_LEN_MIN - EDAM_PUBLISHING_URI_LEN_MAX
Regex: EDAM_PUBLISHING_URI_REGEX