qevercloud::NotebookDescriptor Struct Reference

#include <types.h>

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

Public Attributes
Optional< Guid >	guid
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

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

inline

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

inline

Member Data Documentation

Optional< QString > qevercloud::NotebookDescriptor::contactName

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

Optional< Guid > qevercloud::NotebookDescriptor::guid

The unique identifier of the notebook.

Optional< bool > qevercloud::NotebookDescriptor::hasSharedNotebook

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

Optional< qint32 > qevercloud::NotebookDescriptor::joinedUserCount

The number of users who have joined this notebook.

Optional< QString > qevercloud::NotebookDescriptor::notebookDisplayName

A sequence of characters representing the name of the notebook.