qevercloud::Resource Struct Reference

#include <types.h>

Public Member Functions
bool	operator== (const Resource &other) const
bool	operator!= (const Resource &other) const

Public Attributes
Optional< Guid >	guid
Optional< Guid >	noteGuid
Optional< Data >	data
Optional< QString >	mime
Optional< qint16 >	width
Optional< qint16 >	height
Optional< qint16 >	duration
Optional< bool >	active
Optional< Data >	recognition
Optional< ResourceAttributes >	attributes
Optional< qint32 >	updateSequenceNum
Optional< Data >	alternateData

Detailed Description

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

Member Function Documentation

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

inline

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

inline

Member Data Documentation

Optional< bool > qevercloud::Resource::active

DEPRECATED: ignored.

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.

Optional< ResourceAttributes > qevercloud::Resource::attributes

A list of the attributes for this resource.

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.

Optional< qint16 > qevercloud::Resource::duration

DEPRECATED: ignored.

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

Optional< qint16 > qevercloud::Resource::height

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

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

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

Optional< Data > qevercloud::Resource::recognition

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

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.

Optional< qint16 > qevercloud::Resource::width

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