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

#include <Types.h>

Inheritance diagram for qevercloud::LinkedNotebook:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< QString > shareName
 
Optional< QString > username
 
Optional< QString > shardId
 
Optional< QString > sharedNotebookGlobalId
 
Optional< QString > uri
 
Optional< Guidguid
 
Optional< qint32 > updateSequenceNum
 
Optional< QString > noteStoreUrl
 
Optional< QString > webApiUrlPrefix
 
Optional< QString > stack
 
Optional< qint32 > businessId
 

Detailed Description

A link in a user's account that refers them to a public or individual shared notebook in another user's account.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ businessId

Optional< qint32 > qevercloud::LinkedNotebook::businessId

If set, this will be the unique identifier for the business that owns the notebook to which the linked notebook refers.

◆ guid

Optional< Guid > qevercloud::LinkedNotebook::guid

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

◆ localData

EverCloudLocalData qevercloud::LinkedNotebook::localData

See the declaration of EverCloudLocalData for details

◆ noteStoreUrl

Optional< QString > qevercloud::LinkedNotebook::noteStoreUrl

This field will contain the full URL that clients should use to make NoteStore requests to the server shard that contains that notebook's data. I.e. this is the URL that should be used to create the Thrift HTTP client transport to send messages to the NoteStore service for the account.

◆ shardId

Optional< QString > qevercloud::LinkedNotebook::shardId

The shard ID of the notebook if the notebook is not public.

uri The identifier of the public notebook.

◆ sharedNotebookGlobalId

Optional< QString > qevercloud::LinkedNotebook::sharedNotebookGlobalId

The globally unique identifier (globalId) of the shared notebook that corresponds to the share key, or the GUID of the Notebook that the linked notebook refers to. This field must be filled in with the SharedNotebook.globalId or Notebook.GUID value when creating new LinkedNotebooks. This field replaces the deprecated "shareKey" field.

◆ shareName

Optional< QString > qevercloud::LinkedNotebook::shareName

The display name of the shared notebook. The link owner can change this.

◆ stack

Optional< QString > qevercloud::LinkedNotebook::stack

If this is set, then the notebook is visually contained within a stack of notebooks with this name. All notebooks in the same account with the same 'stack' field are considered to be in the same stack. Notebooks with no stack set are "top level" and not contained within a stack. The link owner can change this and this field is for the benefit of the link owner.

◆ updateSequenceNum

Optional< qint32 > qevercloud::LinkedNotebook::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.

◆ uri

Optional< QString > qevercloud::LinkedNotebook::uri

NOT DOCUMENTED

◆ username

Optional< QString > qevercloud::LinkedNotebook::username

The username of the user who owns the shared or public notebook.

◆ webApiUrlPrefix

Optional< QString > qevercloud::LinkedNotebook::webApiUrlPrefix

This field will contain the initial part of the URLs that should be used to make requests to Evernote's thin client "web API", which provide optimized operations for clients that aren't capable of manipulating the full contents of accounts via the full Thrift data model. Clients should concatenate the relative path for the various servlets onto the end of this string to construct the full URL, as documented on our developer web site.