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

#include <Types.h>

Inheritance diagram for qevercloud::ManageNoteSharesParameters:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< QString > noteGuid
 
Optional< QList< NoteMemberShareRelationship > > membershipsToUpdate
 
Optional< QList< NoteInvitationShareRelationship > > invitationsToUpdate
 
Optional< QList< UserID > > membershipsToUnshare
 
Optional< QList< IdentityID > > invitationsToUnshare
 

Properties

Optional QList
 

Detailed Description

Captures parameters used by clients to manage the shares for a given note via the manageNoteShares function. This is used only to manage the existing memberships and invitations for a note. To invite a new recipient, use NoteStore.createOrUpdateSharedNotes.

The only field of an existing membership or invitation that can be updated by this function is the share privilege.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ invitationsToUnshare

Optional<QList<IdentityID> > qevercloud::ManageNoteSharesParameters::invitationsToUnshare

A list of outstanding invitations to expunge from the service.

◆ invitationsToUpdate

Optional<QList<NoteInvitationShareRelationship> > qevercloud::ManageNoteSharesParameters::invitationsToUpdate

The list of outstanding invitations to update, as matched by the identity field of the NoteInvitationShareRelatioship instances. This field is not meant to be the full set of invitations for the note. Clients should only include those existing invitations that they wish to modify.

◆ localData

EverCloudLocalData qevercloud::ManageNoteSharesParameters::localData

See the declaration of EverCloudLocalData for details

◆ membershipsToUnshare

Optional<QList<UserID> > qevercloud::ManageNoteSharesParameters::membershipsToUnshare

A list of existing memberships to expunge from the service.

◆ membershipsToUpdate

Optional<QList<NoteMemberShareRelationship> > qevercloud::ManageNoteSharesParameters::membershipsToUpdate

A list of existing memberships to update. This field is not meant to be the full set of memberships for the note. Clients should only include those existing memberships that they wish to modify. To remove an existing membership, see the unshares field.

◆ noteGuid

Optional< QString > qevercloud::ManageNoteSharesParameters::noteGuid

The GUID of the note whose shares are being managed.

Property Documentation

◆ QList

Optional qevercloud::ManageNoteSharesParameters::QList