qevercloud::SharedNotebook Struct Reference

#include <types.h>

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

Public Attributes
Optional< qint64 >	id
Optional< qint32 >	userId
Optional< QString >	notebookGuid
Optional< QString >	email
Optional< bool >	notebookModifiable
Optional< bool >	requireLogin
Optional< Timestamp >	serviceCreated
Optional< Timestamp >	serviceUpdated
Optional< QString >	shareKey
Optional< QString >	username
Optional < SharedNotebookPrivilegeLevel::type >	privilege
Optional< bool >	allowPreview
Optional < SharedNotebookRecipientSettings >	recipientSettings

Detailed Description

Shared notebooks represent a relationship between a notebook and a single share invitation recipient.

Member Function Documentation

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

inline

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

inline

Member Data Documentation

Optional< bool > qevercloud::SharedNotebook::allowPreview

Whether or not to grant "READ_NOTEBOOK" privilege without an authentication token, for authenticateToSharedNotebook(...). With the change to "requireLogin" always being true for new shared notebooks, this is the only way to access a shared notebook without an authorization token. This setting expires after the first use of authenticateToSharedNotebook(...) with a valid authentication token.

Optional< QString > qevercloud::SharedNotebook::email

the email address of the recipient - used by the notebook owner to identify who they shared with.

Optional< qint64 > qevercloud::SharedNotebook::id

the primary identifier of the share

Optional< QString > qevercloud::SharedNotebook::notebookGuid

the GUID of the associated notebook shared.

Optional< bool > qevercloud::SharedNotebook::notebookModifiable

(DEPRECATED) a flag indicating the share is read/write -otherwise it's read only. This field is deprecated in favor of the new "privilege" field.

Optional< SharedNotebookPrivilegeLevel::type > qevercloud::SharedNotebook::privilege

The privilege level granted to the notebook, activity stream, and invitations. See the corresponding enumeration for details.

Optional< SharedNotebookRecipientSettings > qevercloud::SharedNotebook::recipientSettings

Settings intended for use only by the recipient of this shared notebook. You should skip setting this value unless you want to change the value contained inside the structure, and only if you are the recipient.

Optional< bool > qevercloud::SharedNotebook::requireLogin

(DEPRECATED) indicates that a user must login to access the share. This field is deprecated and will be "true" for all new shared notebooks. It is read-only and ignored when creating or modifying a shared notebook, except that a shared notebook can be modified to require login. See "allowPreview" for information on privileges and shared notebooks.

Optional< Timestamp > qevercloud::SharedNotebook::serviceCreated

the date the owner first created the share with the specific email address

Optional< Timestamp > qevercloud::SharedNotebook::serviceUpdated

the date the shared notebook was last updated on the service. This will be updated when authenticateToSharedNotebook is called the first time with a shared notebook requiring login (i.e. when the username is bound to that shared notebook).

Optional< QString > qevercloud::SharedNotebook::shareKey

NOT DOCUMENTED

Optional< qint32 > qevercloud::SharedNotebook::userId

the user id of the owner of the notebook

Optional< QString > qevercloud::SharedNotebook::username

the username of the user who can access this share. Once it's assigned it cannot be changed.