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

#include <Types.h>

Inheritance diagram for qevercloud::ManageNotebookSharesParameters:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< QString > notebookGuid
 
Optional< QString > inviteMessage
 
Optional< QList< MemberShareRelationship > > membershipsToUpdate
 
Optional< QList< InvitationShareRelationship > > invitationsToCreateOrUpdate
 
Optional< QList< UserIdentity > > unshares
 

Properties

Optional QList
 

Detailed Description

A structure that captures parameters used by clients to manage the shares for a given notebook via the manageNotebookShares method.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ invitationsToCreateOrUpdate

Optional<QList<InvitationShareRelationship> > qevercloud::ManageNotebookSharesParameters::invitationsToCreateOrUpdate

The list of invitations to update, as matched by the identity field of the InvitationShareRelationship instances, or to create if an existing invitation does not exist. This field is not intended to be the full set of invitations on the notebook and should only include those invitations that you wish to create or update. Note that your invitation could convert into a membership via a service-supported auto-join operation. This happens, for example, when you use an invitation with an Evernote UserID type for a recipient who is a member of the business to which the notebook belongs. Note that to discover the user IDs for business members, the sharer must also be part of the business.

◆ inviteMessage

Optional< QString > qevercloud::ManageNotebookSharesParameters::inviteMessage

If the service sends a message to invitees, this parameter will be used to form the actual message that is sent.

◆ localData

EverCloudLocalData qevercloud::ManageNotebookSharesParameters::localData

See the declaration of EverCloudLocalData for details

◆ membershipsToUpdate

Optional<QList<MemberShareRelationship> > qevercloud::ManageNotebookSharesParameters::membershipsToUpdate

The list of existing memberships to update. This field is not intended to be the full set of memberships for the notebook and should only include those already-existing memberships that you actually want to change. If you want to remove shares, see the unshares fields. If you want to create a membership, i.e. auto-join a business user, you can do this via the invitationsToCreateOrUpdate field using an Evernote UserID of a fellow business member (the created invitation is automatically joined by the service, so the client is creating an invitation, not a membership).

◆ notebookGuid

Optional< QString > qevercloud::ManageNotebookSharesParameters::notebookGuid

The GUID of the notebook whose shares are being managed.

◆ unshares

Optional<QList<UserIdentity> > qevercloud::ManageNotebookSharesParameters::unshares

The list of share relationships to expunge from the service. If the user identity is for an Evernote UserID, then matching invitations or memberships will be removed. If it's an e-mail, then e-mail based shared notebook invitations will be removed. If it's for an Identity ID, then any invitations that match the identity (by identity ID or user ID or e-mail for legacy invitations) will be removed.

Property Documentation

◆ QList

Optional qevercloud::ManageNotebookSharesParameters::QList