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

#include <Types.h>

Inheritance diagram for qevercloud::RelatedContent:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< QString > contentId
 
Optional< QString > title
 
Optional< QString > url
 
Optional< QString > sourceId
 
Optional< QString > sourceUrl
 
Optional< QString > sourceFaviconUrl
 
Optional< QString > sourceName
 
Optional< Timestampdate
 
Optional< QString > teaser
 
Optional< QList< RelatedContentImage > > thumbnails
 
Optional< RelatedContentTypecontentType
 
Optional< RelatedContentAccessaccessType
 
Optional< QString > visibleUrl
 
Optional< QString > clipUrl
 
Optional< Contactcontact
 
Optional< QStringList > authors
 

Properties

Optional QList
 

Detailed Description

A structure identifying one snippet of related content (some information that is not part of an Evernote account but might still be relevant to the user).

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ accessType

Optional< RelatedContentAccess > qevercloud::RelatedContent::accessType

An indication of how this content can be accessed. This type influences the semantics of the url parameter.

◆ authors

Optional< QStringList > qevercloud::RelatedContent::authors

For News articles only. A list of names of the article authors, if available.

◆ clipUrl

Optional< QString > qevercloud::RelatedContent::clipUrl

If set, the client should use this URL for clipping purposes, instead of the URL that was used to retrieve the content. The clipUrl may directly point to an .enex file, for example.

◆ contact

Optional< Contact > qevercloud::RelatedContent::contact

If set, the client may use this Contact for messaging purposes. This will typically only be set for user profiles.

◆ contentId

Optional< QString > qevercloud::RelatedContent::contentId

An identifier that uniquely identifies the content.

◆ contentType

Optional< RelatedContentType > qevercloud::RelatedContent::contentType

The type of this related content.

◆ date

Optional< Timestamp > qevercloud::RelatedContent::date

A timestamp telling the user about the recency of the content.

◆ localData

EverCloudLocalData qevercloud::RelatedContent::localData

See the declaration of EverCloudLocalData for details

◆ sourceFaviconUrl

Optional< QString > qevercloud::RelatedContent::sourceFaviconUrl

The favicon URL of the source which the content belongs to.

◆ sourceId

Optional< QString > qevercloud::RelatedContent::sourceId

An identifier that uniquely identifies the source.

◆ sourceName

Optional< QString > qevercloud::RelatedContent::sourceName

A human-readable name of the source that provided this content.

◆ sourceUrl

Optional< QString > qevercloud::RelatedContent::sourceUrl

A URL the client can access to know more about the source.

◆ teaser

Optional< QString > qevercloud::RelatedContent::teaser

A teaser text to show to the user; usually the first few sentences of the content, excluding the title.

◆ thumbnails

Optional<QList<RelatedContentImage> > qevercloud::RelatedContent::thumbnails

A list of thumbnails the client can show in the snippet.

◆ title

Optional< QString > qevercloud::RelatedContent::title

The main title to show.

◆ url

Optional< QString > qevercloud::RelatedContent::url

The URL the client can use to retrieve the content.

◆ visibleUrl

Optional< QString > qevercloud::RelatedContent::visibleUrl

If set, the client should show this URL to the user, instead of the URL that was used to retrieve the content. This URL should be used when opening the content in an external browser window, or when sharing with another person.

Property Documentation

◆ QList

Optional qevercloud::RelatedContent::QList