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

#include <Types.h>

Inheritance diagram for qevercloud::Resource:
qevercloud::Printable

Public Member Functions

virtual void print (QTextStream &strm) const override
 
bool operator== (const Resource &other) const
 
bool operator!= (const Resource &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< GuidnoteGuid
 
Optional< Datadata
 
Optional< QString > mime
 
Optional< qint16 > width
 
Optional< qint16 > height
 
Optional< qint16 > duration
 
Optional< bool > active
 
Optional< Datarecognition
 
Optional< ResourceAttributesattributes
 
Optional< qint32 > updateSequenceNum
 
Optional< DataalternateData
 

Detailed Description

Every media file that is embedded or attached to a note is represented through a Resource entry.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ active

Optional< bool > qevercloud::Resource::active

If the resource is active or not.

◆ alternateData

Optional< Data > qevercloud::Resource::alternateData

Some Resources may be assigned an alternate data format by the service which may be more appropriate for indexing or rendering than the original data provided by the user. In these cases, the alternate data form will be available via this Data element. If a Resource has no alternate form, this field will be unset.

◆ attributes

Optional< ResourceAttributes > qevercloud::Resource::attributes

A list of the attributes for this resource.

◆ data

Optional< Data > qevercloud::Resource::data

The contents of the resource. Maximum length: The data.body is limited to EDAM_RESOURCE_SIZE_MAX_FREE for free accounts and EDAM_RESOURCE_SIZE_MAX_PREMIUM for premium accounts.

◆ duration

Optional< qint16 > qevercloud::Resource::duration

DEPRECATED: ignored.

◆ guid

Optional< Guid > qevercloud::Resource::guid

The unique identifier of this resource. Will be set whenever a resource is retrieved from the service, but may be null when a client is creating a resource.
Length: EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
Regex: EDAM_GUID_REGEX

◆ height

Optional< qint16 > qevercloud::Resource::height

If set, this contains the display height of this resource, in pixels.

◆ localData

EverCloudLocalData qevercloud::Resource::localData

See the declaration of EverCloudLocalData for details

◆ mime

Optional< QString > qevercloud::Resource::mime

The MIME type for the embedded resource. E.g. "image/gif"
Length: EDAM_MIME_LEN_MIN - EDAM_MIME_LEN_MAX
Regex: EDAM_MIME_REGEX

◆ noteGuid

Optional< Guid > qevercloud::Resource::noteGuid

The unique identifier of the Note that holds this Resource. Will be set whenever the resource is retrieved from the service, but may be null when a client is creating a resource.
Length: EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
Regex: EDAM_GUID_REGEX

◆ recognition

Optional< Data > qevercloud::Resource::recognition

If set, this will hold the encoded data that provides information on search and recognition within this resource.

◆ updateSequenceNum

Optional< qint32 > qevercloud::Resource::updateSequenceNum

A number identifying the last transaction to modify the state of this object. The USN values are sequential within an account, and can be used to compare the order of modifications within the service.

◆ width

Optional< qint16 > qevercloud::Resource::width

If set, this contains the display width of this resource, in pixels.