qevercloud::LinkedNotebook Struct Reference

#include <types.h>

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

Public Attributes
Optional< QString >	shareName
Optional< QString >	username
Optional< QString >	shardId
Optional< QString >	shareKey
Optional< QString >	uri
Optional< Guid >	guid
Optional< qint32 >	updateSequenceNum
Optional< QString >	noteStoreUrl
Optional< QString >	webApiUrlPrefix
Optional< QString >	stack
Optional< qint32 >	businessId

Detailed Description

A link in an users account that refers them to a public or individual share in another user's account.

Member Function Documentation

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

inline

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

inline

Member Data Documentation

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.

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

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.

Optional< QString > qevercloud::LinkedNotebook::shardId

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

shareKey the secret key that provides access to the shared notebook

Optional< QString > qevercloud::LinkedNotebook::shareKey

NOT DOCUMENTED

Optional< QString > qevercloud::LinkedNotebook::shareName

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

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.

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.

Optional< QString > qevercloud::LinkedNotebook::uri

the identifier of the public notebook

Optional< QString > qevercloud::LinkedNotebook::username

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

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.