qevercloud::Publishing Struct Reference

#include <types.h>

Public Member Functions
bool	operator== (const Publishing &other) const
bool	operator!= (const Publishing &other) const

Public Attributes
Optional< QString >	uri
Optional< NoteSortOrder::type >	order
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

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

inline

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

inline

Member Data Documentation

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).

Optional< NoteSortOrder::type > qevercloud::Publishing::order

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

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

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