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

#include <Types.h>

Inheritance diagram for qevercloud::InvitationShareRelationship:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< QString > displayName
 
Optional< UserIdentityrecipientUserIdentity
 
Optional< ShareRelationshipPrivilegeLevelprivilege
 
Optional< UserIDsharerUserId
 

Detailed Description

Describes an invitation to a person to use their Evernote credentials to become a member of a notebook.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ displayName

Optional< QString > qevercloud::InvitationShareRelationship::displayName

The string that clients should show to users to represent this invitation.

◆ localData

EverCloudLocalData qevercloud::InvitationShareRelationship::localData

See the declaration of EverCloudLocalData for details

◆ privilege

Optional< ShareRelationshipPrivilegeLevel > qevercloud::InvitationShareRelationship::privilege

The privilege level at which the member will be joined, if it turns out that the member is not already joined at a higher level. Note that the identity field may not uniquely identify an Evernote User ID, and so we won't know until the invitation is redeemed whether or not the recipient already has privilege.

◆ recipientUserIdentity

Optional< UserIdentity > qevercloud::InvitationShareRelationship::recipientUserIdentity

Identifies the recipient of the invitation. The user identity type can be either EMAIL, EVERNOTE or IDENTITYID. If the invitation was created using the classic notebook sharing APIs it will be EMAIL. If it was created using the new identity-based notebook sharing APIs it will either be EVERNOTE or IDENTITYID, depending on whether we can map the identity to an Evernote user at the time of creation.

◆ sharerUserId

Optional< UserID > qevercloud::InvitationShareRelationship::sharerUserId

The user id of the user who most recently shared this notebook to this identity. This field is used by the service to convey information to the user, so clients should treat it as read-only.