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

#include <Types.h>

Inheritance diagram for qevercloud::Note:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< Guidguid
 
Optional< QString > title
 
Optional< QString > content
 
Optional< QByteArray > contentHash
 
Optional< qint32 > contentLength
 
Optional< Timestampcreated
 
Optional< Timestampupdated
 
Optional< Timestampdeleted
 
Optional< bool > active
 
Optional< qint32 > updateSequenceNum
 
Optional< QString > notebookGuid
 
Optional< QList< Guid > > tagGuids
 
Optional< QList< Resource > > resources
 
Optional< NoteAttributesattributes
 
Optional< QStringList > tagNames
 
Optional< QList< SharedNote > > sharedNotes
 
Optional< NoteRestrictionsrestrictions
 
Optional< NoteLimitslimits
 

Properties

Optional QList
 

Detailed Description

Represents a single note in the user's account.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ active

Optional< bool > qevercloud::Note::active

If the note is available for normal actions and viewing, this flag will be set to true.

◆ attributes

Optional< NoteAttributes > qevercloud::Note::attributes

A list of the attributes for this note. If the list of attributes are omitted on a call to updateNote(), then the server will assume that no changes have been made to the resources.

◆ content

Optional< QString > qevercloud::Note::content

The XHTML block that makes up the note. This is the canonical form of the note's contents, so will include abstract Evernote tags for internal resource references. A client may create a separate transformed version of this content for internal presentation, but the same canonical bytes should be used for transmission and comparison unless the user chooses to modify their content.
Length: EDAM_NOTE_CONTENT_LEN_MIN - EDAM_NOTE_CONTENT_LEN_MAX

◆ contentHash

Optional< QByteArray > qevercloud::Note::contentHash

The binary MD5 checksum of the UTF-8 encoded content body. This will always be set by the server, but clients may choose to omit this when they submit a note with content.
Length: EDAM_HASH_LEN (exactly)

◆ contentLength

Optional< qint32 > qevercloud::Note::contentLength

The number of Unicode characters in the content of the note. This will always be set by the service, but clients may choose to omit this value when they submit a Note.

◆ created

Optional< Timestamp > qevercloud::Note::created

The date and time when the note was created in one of the clients. In most cases, this will match the user's sense of when the note was created, and ordering between notes will be based on ordering of this field. However, this is not a "reliable" timestamp if a client has an incorrect clock, so it cannot provide a true absolute ordering between notes. Notes created directly through the service (e.g. via the web GUI) will have an absolutely ordered "created" value.

◆ deleted

Optional< Timestamp > qevercloud::Note::deleted

If present, the note is considered "deleted", and this stores the date and time when the note was deleted by one of the clients. In most cases, this will match the user's sense of when the note was deleted, but this field may be unreliable due to the possibility of client clock errors.

◆ guid

Optional< Guid > qevercloud::Note::guid

The unique identifier of this note. Will be set by the server, but will be omitted by clients calling NoteStore.createNote()
Length: EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
Regex: EDAM_GUID_REGEX

◆ limits

Optional< NoteLimits > qevercloud::Note::limits

NOT DOCUMENTED

◆ localData

EverCloudLocalData qevercloud::Note::localData

See the declaration of EverCloudLocalData for details

◆ notebookGuid

Optional< QString > qevercloud::Note::notebookGuid

The unique identifier of the notebook that contains this note. If no notebookGuid is provided on a call to createNote(), the default notebook will be used instead.
Length: EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
Regex: EDAM_GUID_REGEX

◆ resources

Optional<QList<Resource> > qevercloud::Note::resources

The list of resources that are embedded within this note. If the list of resources are omitted on a call to updateNote(), then the server will assume that no changes have been made to the resources. The binary contents of the resources must be provided when the resource is first sent to the service, but it will be omitted by the service when the Note is returned in the future. Maximum: EDAM_NOTE_RESOURCES_MAX resources per note

◆ restrictions

Optional< NoteRestrictions > qevercloud::Note::restrictions

If this field is set, the user has note-level permissions that may differ from their notebook-level permissions. In this case, the restrictions structure specifies a set of restrictions limiting the actions that a user may take on the note based on their note-level permissions. If this field is unset, then there are no note-specific restrictions. However, a client may still be limited based on the user's notebook permissions.

◆ sharedNotes

Optional<QList<SharedNote> > qevercloud::Note::sharedNotes

The list of recipients with whom this note has been shared. This field will be unset if the caller has access to the note via the containing notebook, but does not have activity feed permission for that notebook. This field is read-only. Clients may not make changes to a note's sharing state via this field.

◆ tagGuids

Optional<QList<Guid> > qevercloud::Note::tagGuids

A list of the GUID identifiers for tags that are applied to this note. This may be provided in a call to createNote() to unambiguously declare the tags that should be assigned to the new note. Alternately, clients may pass the names of desired tags via the 'tagNames' field during note creation. If the list of tags are omitted on a call to createNote(), then the server will assume that no changes have been made to the resources. Maximum: EDAM_NOTE_TAGS_MAX tags per note

◆ tagNames

Optional< QStringList > qevercloud::Note::tagNames

May be provided by clients during calls to createNote() as an alternative to providing the tagGuids of existing tags. If any tagNames are provided during createNote(), these will be found, or created if they don't already exist. Created tags will have no parent (they will be at the top level of the tag panel).

◆ title

Optional< QString > qevercloud::Note::title

The subject of the note. Can't begin or end with a space.
Length: EDAM_NOTE_TITLE_LEN_MIN - EDAM_NOTE_TITLE_LEN_MAX
Regex: EDAM_NOTE_TITLE_REGEX

◆ updated

Optional< Timestamp > qevercloud::Note::updated

The date and time when the note was last modified in one of the clients. In most cases, this will match the user's sense of when the note was modified, but this field may not be absolutely reliable due to the possibility of client clock errors.

◆ updateSequenceNum

Optional< qint32 > qevercloud::Note::updateSequenceNum

A number identifying the last transaction to modify the state of this note (including changes to the note's attributes or resources). The USN values are sequential within an account, and can be used to compare the order of modifications within the service.

Property Documentation

◆ QList

Optional qevercloud::Note::QList