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

#include <Types.h>

Inheritance diagram for qevercloud::SharedNotebook:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< qint64 > id
 
Optional< UserIDuserId
 
Optional< GuidnotebookGuid
 
Optional< QString > email
 
Optional< IdentityIDrecipientIdentityId
 
Optional< bool > notebookModifiable
 
Optional< TimestampserviceCreated
 
Optional< TimestampserviceUpdated
 
Optional< QString > globalId
 
Optional< QString > username
 
Optional< SharedNotebookPrivilegeLevelprivilege
 
Optional< SharedNotebookRecipientSettingsrecipientSettings
 
Optional< UserIDsharerUserId
 
Optional< QString > recipientUsername
 
Optional< UserIDrecipientUserId
 
Optional< TimestampserviceAssigned
 

Detailed Description

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

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ email

Optional< QString > qevercloud::SharedNotebook::email

A string containing a display name for the recipient of the share. This may be an email address, a phone number, a full name, or some other descriptive string This field is read-only to clients. It will be filled in by the service when returning shared notebooks.

◆ globalId

Optional< QString > qevercloud::SharedNotebook::globalId

An immutable, opaque string that acts as a globally unique identifier for this shared notebook record. You can use this field to match linked notebook and shared notebook records as well as to create new LinkedNotebook records. This field replaces the deprecated shareKey field.

◆ id

Optional< qint64 > qevercloud::SharedNotebook::id

The primary identifier of the share, which is not globally unique.

◆ localData

EverCloudLocalData qevercloud::SharedNotebook::localData

See the declaration of EverCloudLocalData for details

◆ notebookGuid

Optional< Guid > qevercloud::SharedNotebook::notebookGuid

The GUID of the notebook that has been shared.

◆ notebookModifiable

Optional< bool > qevercloud::SharedNotebook::notebookModifiable

DEPRECATED

◆ privilege

Optional< SharedNotebookPrivilegeLevel > qevercloud::SharedNotebook::privilege

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

◆ recipientIdentityId

Optional< IdentityID > qevercloud::SharedNotebook::recipientIdentityId

The IdentityID of the share recipient. If present, only the user who has claimed that identity may access this share.

◆ recipientSettings

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.

◆ recipientUserId

Optional< UserID > qevercloud::SharedNotebook::recipientUserId

The id of the user who can access this share. This is the id for the user with the username in recipientUsername. This value is read-only and set by the service. Value set by clients will be ignored. This field may be unset for unjoined notebooks and is always set if serviceAssigned is set. Clients should prefer this field over recipientUsername unless they need to use usernames directly.

◆ recipientUsername

Optional< QString > qevercloud::SharedNotebook::recipientUsername

The username of the user who can access this share. This is the username for the user with the id in recipientUserId. This value can be set by clients when calling shareNotebook(...), and that will result in the created SharedNotebook being assigned to a user. This value is always set if serviceAssigned is set.

◆ serviceAssigned

Optional< Timestamp > qevercloud::SharedNotebook::serviceAssigned

The date this SharedNotebook was assigned (i.e. has been associated with an Evernote user whose user ID is set in recipientUserId). Unset if the SharedNotebook is not assigned. This field is a read-only value that is set by the service.

◆ serviceCreated

Optional< Timestamp > qevercloud::SharedNotebook::serviceCreated

The date that the owner first created the share with the specific email address.

◆ serviceUpdated

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 (i.e. when the username is bound to that shared notebook), and also when the SharedNotebook privilege is updated as part of a shareNotebook(...) call, as well as on any calls to updateSharedNotebook(...).

◆ sharerUserId

Optional< UserID > qevercloud::SharedNotebook::sharerUserId

The user id of the user who shared a notebook via this shared notebook instance. This may not be the same as userId, since a user with full access to a notebook may have created a new share for that notebook. For Business, this represents the user who shared the business notebook. This field is currently unset for a SharedNotebook created by joining a notebook that has been published to the business.

◆ userId

Optional< UserID > qevercloud::SharedNotebook::userId

The user id of the owner of the notebook.

◆ username

Optional< QString > qevercloud::SharedNotebook::username

DEPRECATED. The username of the user who can access this share. This value is read-only to clients. It will be filled in by the service when returning shared notebooks.