QEverCloud
6.1.0
Unofficial Evernote Cloud API for Qt
|
#include <Services.h>
Protected Member Functions | |
INoteStore (QObject *parent) | |
Service: NoteStore
The NoteStore service is used by EDAM clients to exchange information about the collection of notes in an account. This is primarily used for synchronization, but could also be used by a "thin" client without a full local cache.
Most functions take an "authenticationToken" parameter, which is the value returned by the UserStore which permits access to the account.
Calls which require an authenticationToken may throw an EDAMUserException for the following reasons:
|
inlineprotected |
|
pure virtual |
Asks the service to produce an authentication token that can be used to access the contents of a single Note which was individually shared from someone's account. This authenticationToken can be used with the various other NoteStore calls to find and retrieve the Note and its directly-referenced children.
guid | The GUID identifying this Note on this shard. |
noteKey | The 'noteKey' identifier from the Note that was originally created via a call to shareNote() and then given to a recipient to access. |
authenticationToken | An optional authenticationToken that identifies the user accessing the shared note. This parameter may be required to access some shared notes. |
EDAMUserException |
|
EDAMNotFoundException |
|
EDAMSystemException |
|
|
pure virtual |
Asynchronous version of authenticateToSharedNote
|
pure virtual |
Asks the service to produce an authentication token that can be used to access the contents of a shared notebook from someone else's account. This authenticationToken can be used with the various other NoteStore calls to find and retrieve notes, and if the permissions in the shared notebook are sufficient, to make changes to the contents of the notebook.
shareKeyOrGlobalId | May be one of the following:
|
authenticationToken | If a non-empty string is provided, this is the full user-based authentication token that identifies the user who is currently logged in and trying to access the shared notebook. If this string is empty, the service will attempt to authenticate to the shared notebook without any logged in user. |
EDAMSystemException |
|
EDAMNotFoundException |
|
EDAMUserException |
|
|
pure virtual |
Asynchronous version of authenticateToSharedNotebook
|
pure virtual |
Performs a deep copy of the Note with the provided GUID 'noteGuid' into the Notebook with the provided GUID 'toNotebookGuid'. The caller must be the owner of both the Note and the Notebook. This creates a new Note in the destination Notebook with new content and Resources that match all of the content and Resources from the original Note, but with new GUID identifiers. The original Note is not modified by this operation. The copied note is considered as an "upload" for the purpose of upload transfer limit calculation, so its size is added to the upload count for the owner.
If the original note has been shared and has SharedNote records, the shares are NOT copied.
noteGuid | The GUID of the Note to copy. |
toNotebookGuid | The GUID of the Notebook that should receive the new Note. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of copyNote
|
pure virtual |
Asks the service to make a linked notebook with the provided name, username of the owner and identifiers provided. A linked notebook can be either a link to a public notebook or to a private shared notebook.
linkedNotebook | The desired fields for the linked notebook must be provided on this object. The name of the linked notebook must be set. Either a username uri or a shard id and share key must be provided otherwise a EDAMUserException is thrown. |
EDAMUserException |
|
EDAMSystemException |
|
|
pure virtual |
Asynchronous version of createLinkedNotebook
|
pure virtual |
Asks the service to make a note with the provided set of information.
note | A Note object containing the desired fields to be populated on the service. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of createNote
|
pure virtual |
Asks the service to make a notebook with the provided name.
notebook | The desired fields for the notebook must be provided on this object. The name of the notebook must be set, and either the 'active' or 'defaultNotebook' fields may be set by the client at creation. If a notebook exists in the account with the same name (via case-insensitive compare), this will throw an EDAMUserException. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of createNotebook
|
pure virtual |
Share a notebook by a messaging thread ID or a list of contacts. This function is intended to be used in conjunction with Evernote messaging, and as such does not notify the recipient that a notebook has been shared with them.
Sharing with a subset of participants on a thread is accomplished by specifying both a thread ID and a list of contacts. This ensures that even if those contacts are on the thread under a deactivated identity, the correct user (the one who has the given contact on the thread) receives the share.
authenticationToken | An authentication token that grants the caller permission to share the notebook. This should be an owner token if the notebook is owned by the caller. If the notebook is a business notebook to which the caller has full access, this should be their business authentication token. If the notebook is a shared (non-business) notebook to which the caller has full access, this should be the shared notebook authentication token returned by NoteStore.authenticateToNotebook. |
shareTemplate | Specifies the GUID of the notebook to be shared, the privilege at which the notebook should be shared, and the recipient information. |
EDAMUserException |
|
EDAMInvalidContactsException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of createOrUpdateNotebookShares
|
pure virtual |
Asks the service to make a saved search with a set of information.
search | The desired list of fields for the search are specified in this object. The caller must specify the name and query for the search, and may optionally specify a search scope. The SavedSearch.format field is ignored by the service. |
EDAMUserException |
|
|
pure virtual |
Asynchronous version of createSearch
|
pure virtual |
Asks the service to make a tag with a set of information.
tag | The desired list of fields for the tag are specified in this object. The caller must specify the tag name, and may provide the parentGUID. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of createTag
|
pure virtual |
Moves the note into the trash. The note may still be undeleted, unless it is expunged. This is equivalent to calling updateNote() after setting Note.active = false
guid | The GUID of the note to delete. |
EDAMUserException |
|
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of deleteNote
|
pure virtual |
Attempts to send a single note to one or more email recipients.
NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
authenticationToken | The note will be sent as the user logged in via this token, using that user's registered email address. If the authenticated user doesn't have permission to read that note, the emailing will fail. |
parameters | The note must be specified either by GUID (in which case it will be sent using the existing data in the service), or else the full Note must be passed to this call. This also specifies the additional email fields that will be used in the email. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of emailNote
|
pure virtual |
Permanently expunges the linked notebook from the account.
NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
guid | The LinkedNotebook.guid field of the LinkedNotebook to permanently remove from the account. |
|
pure virtual |
Asynchronous version of expungeLinkedNotebook
|
pure virtual |
Permanently removes a Note, and all of its Resources, from the service.
NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
guid | The GUID of the note to delete. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of expungeNote
|
pure virtual |
Permanently removes the notebook from the user's account. After this action, the notebook is no longer available for undeletion, etc. If the notebook contains any Notes, they will be moved to the current default notebook and moved into the trash (i.e. Note.active=false).
NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
guid | The GUID of the notebook to delete. |
EDAMUserException |
|
|
pure virtual |
Asynchronous version of expungeNotebook
|
pure virtual |
Permanently deletes the saved search with the provided GUID, if present.
NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
guid | The GUID of the search to delete. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of expungeSearch
|
pure virtual |
Permanently deletes the tag with the provided GUID, if present.
NOTE: This function is not generally available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
guid | The GUID of the tag to delete. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of expungeTag
|
pure virtual |
This function is used to determine how many notes are found for each notebook and tag in the user's account, given a current set of filter parameters that determine the current selection. This function will return a structure that gives the note count for each notebook and tag that has at least one note under the requested filter. Any notebook or tag that has zero notes in the filtered set will not be listed in the reply to this function (so they can be assumed to be 0).
authenticationToken | Must be a valid token for the user's account unless the NoteFilter 'notebookGuid' is the GUID of a public notebook. |
filter | The note selection filter that is currently being applied. The note counts are to be calculated with this filter applied to the total set of notes in the user's account. |
withTrash | If true, then the NoteCollectionCounts.trashCount will be calculated and supplied in the reply. Otherwise, the trash value will be omitted. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of findNoteCounts
|
pure virtual |
Finds the position of a note within a sorted subset of all of the user's notes. This may be useful for thin clients that are displaying a paginated listing of a large account, which need to know where a particular note sits in the list without retrieving all notes first.
authenticationToken | Must be a valid token for the user's account unless the NoteFilter 'notebookGuid' is the GUID of a public notebook. |
filter | The list of criteria that will constrain the notes to be returned. |
guid | The GUID of the note to be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of findNoteOffset
|
pure virtual |
Used to find the high-level information about a set of the notes from a user's account based on various criteria specified via a NoteFilter object.
Web applications that wish to periodically check for new content in a user's Evernote account should consider using webhooks instead of polling this API. See http://dev.evernote.com/documentation/cloud/chapters/polling_notification.php for more information.
authenticationToken | Must be a valid token for the user's account unless the NoteFilter 'notebookGuid' is the GUID of a public notebook. |
filter | The list of criteria that will constrain the notes to be returned. |
offset | The numeric index of the first note to show within the sorted results. The numbering scheme starts with "0". This can be used for pagination. |
maxNotes | The maximum notes to return in this query. The service will return a set of notes that is no larger than this number, but may return fewer notes if needed. The NoteList.totalNotes field in the return value will indicate whether there are more values available after the returned set. Currently, the service will not return more than 250 notes in a single request, but this number may change in the future. |
resultSpec | This specifies which information should be returned for each matching Note. The fields on this structure can be used to eliminate data that the client doesn't need, which will reduce the time and bandwidth to receive and process the reply. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of findNotesMetadata
|
pure virtual |
Identify related entities on the service, such as notes, notebooks, tags and users in a business related to notes or content.
query | The information about which we are finding related entities. |
resultSpec | Allows the client to indicate the type and quantity of information to be returned, allowing a saving of time and bandwidth. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of findRelated
|
pure virtual |
Returns the notebook that should be used to store new notes in the user's account when no other notebooks are specified.
|
pure virtual |
Asynchronous version of getDefaultNotebook
|
pure virtual |
Asks the NoteStore to provide the state of the account in order of last modification. This request retrieves one block of the server's state so that a client can make several small requests against a large account rather than getting the entire state in one big message. This call gives fine-grained control of the data that will be received by a client by omitting data elements that a client doesn't need. This may reduce network traffic and sync times.
afterUSN | The client can pass this value to ask only for objects that have been updated after a certain point. This allows the client to receive updates after its last checkpoint rather than doing a full synchronization on every pass. The default value of "0" indicates that the client wants to get objects from the start of the account. |
maxEntries | The maximum number of modified objects that should be returned in the result SyncChunk. This can be used to limit the size of each individual message to be friendly for network transfer. |
filter | The caller must set some of the flags in this structure to specify which data types should be returned during the synchronization. See the SyncChunkFilter structure for information on each flag. |
EDAMUserException |
|
|
pure virtual |
Asynchronous version of getFilteredSyncChunk
|
pure virtual |
Asks the NoteStore to provide information about the contents of a linked notebook that has been shared with the caller, or that is public to the world. This will return a result that is similar to getSyncChunk, but will only contain entries that are visible to the caller. I.e. only that particular Notebook will be visible, along with its Notes, and Tags on those Notes.
This function must be called on the shard that owns the referenced notebook. (I.e. the shardId in /shard/shardId/edam/note must be the same as LinkedNotebook.shardId.)
authenticationToken | This should be an authenticationToken for the guest who has received the invitation to the share. (I.e. this should not be the result of NoteStore.authenticateToSharedNotebook) |
linkedNotebook | This structure should contain identifying information and permissions to access the notebook in question. This must contain the valid fields for either a shared notebook (e.g. shareKey) or a public notebook (e.g. username, uri) |
afterUSN | The client can pass this value to ask only for objects that have been updated after a certain point. This allows the client to receive updates after its last checkpoint rather than doing a full synchronization on every pass. The default value of "0" indicates that the client wants to get objects from the start of the account. |
maxEntries | The maximum number of modified objects that should be returned in the result SyncChunk. This can be used to limit the size of each individual message to be friendly for network transfer. Applications should not request more than 256 objects at a time, and must handle the case where the service returns less than the requested number of objects in a given request even though more objects are available on the service. |
fullSyncOnly | If true, then the client only wants initial data for a full sync. In this case, the service will not return any expunged objects, and will not return any Resources, since these are also provided in their corresponding Notes. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getLinkedNotebookSyncChunk
|
pure virtual |
Asks the NoteStore to provide information about the status of a linked notebook that has been shared with the caller, or that is public to the world. This will return a result that is similar to getSyncState, but may omit SyncState.uploaded if the caller doesn't have permission to write to the linked notebook.
This function must be called on the shard that owns the referenced notebook. (I.e. the shardId in /shard/shardId/edam/note must be the same as LinkedNotebook.shardId.)
authenticationToken | This should be an authenticationToken for the guest who has received the invitation to the share. (I.e. this should not be the result of NoteStore.authenticateToSharedNotebook) |
linkedNotebook | This structure should contain identifying information and permissions to access the notebook in question. |
EDAMUserException |
|
EDAMNotFoundException |
|
SystemException |
|
|
pure virtual |
Asynchronous version of getLinkedNotebookSyncState
|
pure virtual |
DEPRECATED. See getNoteWithResultSpec.
This function is equivalent to getNoteWithResultSpec, with each of the boolean parameters mapping to the equivalent field of a NoteResultSpec. The Note.sharedNotes field is never populated on the returned note. To get a note with its shares, use getNoteWithResultSpec.
|
pure virtual |
Get all of the application data for the note identified by GUID, with values returned within the LazyMap fullMap field. If there are no applicationData entries, then a LazyMap with an empty fullMap will be returned. If your application only needs to fetch its own applicationData entry, use getNoteApplicationDataEntry instead.
|
pure virtual |
Asynchronous version of getNoteApplicationData
|
pure virtual |
Get the value of a single entry in the applicationData map for the note identified by GUID.
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getNoteApplicationDataEntry
|
pure virtual |
Asynchronous version of getNote
|
pure virtual |
Returns the current state of the notebook with the provided GUID. The notebook may be active or deleted (but not expunged).
guid | The GUID of the notebook to be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getNotebook
|
pure virtual |
Return the share relationships for the given notebook, including both the invitations and the memberships.
Note: Beta method! This method is currently intended for limited use by Evernote clients that have discussed using this routine with the platform team.
|
pure virtual |
Asynchronous version of getNotebookShares
|
pure virtual |
Returns XHTML contents of the note with the provided GUID. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
guid | The GUID of the note to be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getNoteContent
|
pure virtual |
Returns a block of the extracted plain text contents of the note with the provided GUID. This text can be indexed for search purposes by a light client that doesn't have capabilities to extract all of the searchable text content from the note and its resources.
If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
guid | The GUID of the note to be retrieved. |
noteOnly | If true, this will only return the text extracted from the ENML contents of the note itself. If false, this will also include the extracted text from any text-bearing resources (PDF, recognized images) |
tokenizeForIndexing | If true, this will break the text into cleanly separated and sanitized tokens. If false, this will return the more raw text extraction, with its original punctuation, capitalization, spacing, etc. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getNoteSearchText
|
pure virtual |
Returns a list of the names of the tags for the note with the provided guid. This can be used with authentication to get the tags for a user's own note, or can be used without valid authentication to retrieve the names of the tags for a note in a public notebook.
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getNoteTagNames
|
pure virtual |
This can be used to retrieve a previous version of a Note after it has been updated within the service. The caller must identify the note (via its guid) and the version (via the updateSequenceNumber of that version). to find a listing of the stored version USNs for a note, call listNoteVersions. This call is only available for notes in Premium accounts. (I.e. access to past versions of Notes is a Premium-only feature.)
noteGuid | The GUID of the note to be retrieved. |
updateSequenceNum | The USN of the version of the note that is being retrieved |
withResourcesData | If true, any Resource elements in this Note will include the binary contents of their 'data' field's body. |
withResourcesRecognition | If true, any Resource elements will include the binary contents of the 'recognition' field's body if recognition data is present. |
withResourcesAlternateData | If true, any Resource elements in this Note will include the binary contents of their 'alternateData' fields' body, if an alternate form is present. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getNoteVersion
|
pure virtual |
Returns the current state of the note in the service with the provided GUID. The ENML contents of the note will only be provided if the 'withContent' parameter is true. The service will include the meta-data for each resource in the note, but the binary content depends on whether it is explicitly requested in resultSpec parameter. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string). The applicationData fields are returned as keysOnly.
authenticationToken | An authentication token that grants the caller access to the requested note. |
guid | The GUID of the note to be retrieved. |
resultSpec | A structure specifying the fields of the note that the caller would like to get. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getNoteWithResultSpec
|
pure virtual |
Looks for a user account with the provided userId on this NoteStore shard and determines whether that account contains a public notebook with the given URI. If the account is not found, or no public notebook exists with this URI, this will throw an EDAMNotFoundException, otherwise this will return the information for that Notebook.
If a notebook is visible on the web with a full URL like http://www.evernote.com/pub/sethdemo/api Then 'sethdemo' is the username that can be used to look up the userId, and 'api' is the publicUri.
userId | The numeric identifier for the user who owns the public notebook. To find this value based on a username string, you can invoke UserStore.getPublicUserInfo |
publicUri | The uri string for the public notebook, from Notebook.publishing.uri. |
EDAMNotFoundException |
|
EDAMSystemException |
|
|
pure virtual |
Asynchronous version of getPublicNotebook
|
pure virtual |
Returns the current state of the resource in the service with the provided GUID. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string). Only the keys for the applicationData will be returned.
guid | The GUID of the resource to be retrieved. |
withData | If true, the Resource will include the binary contents of the 'data' field's body. |
withRecognition | If true, the Resource will include the binary contents of the 'recognition' field's body if recognition data is present. |
withAttributes | If true, the Resource will include the attributes |
withAlternateData | If true, the Resource will include the binary contents of the 'alternateData' field's body, if an alternate form is present. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
If the Resource with the provided GUID has an alternate data representation (indicated via the Resource.alternateData field), then this request can be used to retrieve the binary contents of that alternate data file. If the caller asks about a resource that has no alternate data form, this will throw EDAMNotFoundException.
guid | The GUID of the resource whose recognition data should be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getResourceAlternateData
|
pure virtual |
Get all of the application data for the Resource identified by GUID, with values returned within the LazyMap fullMap field. If there are no applicationData entries, then a LazyMap with an empty fullMap will be returned. If your application only needs to fetch its own applicationData entry, use getResourceApplicationDataEntry instead.
|
pure virtual |
Asynchronous version of getResourceApplicationData
|
pure virtual |
Get the value of a single entry in the applicationData map for the Resource identified by GUID.
EDAMNotFoundException |
|
pure virtual |
Asynchronous version of getResourceApplicationDataEntry
|
pure virtual |
Asynchronous version of getResource
|
pure virtual |
Returns the set of attributes for the Resource with the provided GUID. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
guid | The GUID of the resource whose attributes should be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getResourceAttributes
|
pure virtual |
Returns the current state of a resource, referenced by containing note GUID and resource content hash.
noteGuid | The GUID of the note that holds the resource to be retrieved. |
contentHash | The MD5 checksum of the resource within that note. Note that this is the binary checksum, for example from Resource.data.bodyHash, and not the hex-encoded checksum that is used within an en-media tag in a note body. |
withData | If true, the Resource will include the binary contents of the 'data' field's body. |
withRecognition | If true, the Resource will include the binary contents of the 'recognition' field's body. |
withAlternateData | If true, the Resource will include the binary contents of the 'alternateData' field's body, if an alternate form is present. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getResourceByHash
|
pure virtual |
Returns binary data of the resource with the provided GUID. For example, if this were an image resource, this would contain the raw bits of the image. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
guid | The GUID of the resource to be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getResourceData
|
pure virtual |
Returns the binary contents of the recognition index for the resource with the provided GUID. If the caller asks about a resource that has no recognition data, this will throw EDAMNotFoundException. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
guid | The GUID of the resource whose recognition data should be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getResourceRecognition
|
pure virtual |
Returns a block of the extracted plain text contents of the resource with the provided GUID. This text can be indexed for search purposes by a light client that doesn't have capability to extract all of the searchable text content from a resource.
If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
guid | The GUID of the resource to be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getResourceSearchText
|
pure virtual |
Returns the current state of the search with the provided GUID.
guid | The GUID of the search to be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getSearch
|
pure virtual |
This function is used to retrieve extended information about a shared notebook by a guest who has already authenticated to access that notebook. This requires an 'authenticationToken' parameter which should be the resut of a call to authenticateToSharedNotebook(...). I.e. this is the token that gives access to the particular shared notebook in someone else's account – it's not the authenticationToken for the owner of the notebook itself.
authenticationToken | Should be the authentication token retrieved from the reply of authenticateToSharedNotebook(), proving access to a particular shared notebook. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getSharedNotebookByAuth
|
pure virtual |
Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token.
|
pure virtual |
Asynchronous version of getSyncState
|
pure virtual |
Returns the current state of the Tag with the provided GUID.
guid | The GUID of the tag to be retrieved. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of getTag
|
pure virtual |
Returns a list of all the notebooks in a business that the user has permission to access, regardless of whether the user has joined them. This includes notebooks that have been shared with the entire business as well as notebooks that have been shared directly with the user.
authenticationToken | A business authentication token obtained by calling UserStore.authenticateToBusiness. |
EDAMUserException |
|
|
pure virtual |
Asynchronous version of listAccessibleBusinessNotebooks
|
pure virtual |
Returns a list of linked notebooks
|
pure virtual |
Asynchronous version of listLinkedNotebooks
|
pure virtual |
Returns a list of all of the notebooks in the account.
|
pure virtual |
Asynchronous version of listNotebooks
|
pure virtual |
Returns a list of the prior versions of a particular note that are saved within the service. These prior versions are stored to provide a recovery from unintentional removal of content from a note. The identifiers that are returned by this call can be used with getNoteVersion to retrieve the previous note. The identifiers will be listed from the most recent versions to the oldest. This call is only available for notes in Premium accounts. (I.e. access to past versions of Notes is a Premium-only feature.)
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of listNoteVersions
|
pure virtual |
Returns a list of the searches in the account. Evernote does not support the undeletion of searches, so this will only include active searches.
|
pure virtual |
Asynchronous version of listSearches
|
pure virtual |
Lists the collection of shared notebooks for all notebooks in the users account.
|
pure virtual |
Asynchronous version of listSharedNotebooks
|
pure virtual |
Returns a list of the tags in the account. Evernote does not support the undeletion of tags, so this will only include active tags.
|
pure virtual |
Asynchronous version of listTags
|
pure virtual |
Returns a list of the tags that are applied to at least one note within the provided notebook. If the notebook is public, the authenticationToken may be ignored.
notebookGuid | the GUID of the notebook to use to find tags |
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of listTagsByNotebook
|
pure virtual |
Manage invitations and memberships associated with a given notebook.
Note: Beta method! This method is currently intended for limited use by Evernote clients that have discussed using this routine with the platform team.
parameters | A structure containing all parameters for the updates. See the structure documentation for details. |
EDAMUserException |
|
|
pure virtual |
Asynchronous version of manageNotebookShares
|
pure virtual |
|
pure virtual |
Update, or create, an entry in the applicationData map for the note identified by guid.
|
pure virtual |
Asynchronous version of setNoteApplicationDataEntry
|
pure virtual |
Set values for the recipient settings associated with a notebook share. Only the recipient of the share can update their recipient settings.
If you do not wish to, or cannot, change one of the recipient settings fields, you must leave that field unset in recipientSettings. This method will skip that field for updates and attempt to leave the existing value as it is.
If recipientSettings.inMyList is false, both reminderNotifyInApp and reminderNotifyEmail will be either left as null or converted to false (if currently true).
To unset a notebook's stack, pass in the empty string for the stack field.
authenticationToken | The owner authentication token for the recipient of the share. |
EDAMNotFoundException |
|
EDAMUserException |
|
|
pure virtual |
Asynchronous version of setNotebookRecipientSettings
|
pure virtual |
|
pure virtual |
Update, or create, an entry in the applicationData map for the Resource identified by guid.
|
pure virtual |
Asynchronous version of setResourceApplicationDataEntry
|
pure virtual |
If this note is not already shared publicly (via its own direct URL), then this will start sharing that note. This will return the secret "Note Key" for this note that can currently be used in conjunction with the Note's GUID to gain direct read-only access to the Note. If the note is already shared, then this won't make any changes to the note, and the existing "Note Key" will be returned. The only way to change the Note Key for an existing note is to stopSharingNote first, and then call this function.
guid | The GUID of the note to be shared. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of shareNote
|
pure virtual |
@Deprecated for first-party clients. See createOrUpdateNotebookShares.
Share a notebook with an email address, and optionally to a specific recipient. If an existing SharedNotebook associated with sharedNotebook.notebookGuid is found by recipientUsername or email, then the values of sharedNotebook will be used to update the existing record, else a new record will be created.
If recipientUsername is set and there is already a SharedNotebook for that Notebook with that recipientUsername and the privileges on the existing notebook are lower, than on this one, this will update the privileges and sharerUserId. If there isn't an existing SharedNotebook for recipientUsername, this will create and return a shared notebook for that email and recipientUsername. If recipientUsername is not set and there already is a SharedNotebook for a Notebook for that email address and the privileges on the existing SharedNotebook are lower than on this one, this will update the privileges and sharerUserId, and return the updated SharedNotebook. Otherwise, this will create and return a SharedNotebook for the email address.
If the authenticationToken is a Business auth token, recipientUsername is set and the recipient is in the same business as the business auth token, this method will also auto-join the business user to the SharedNotebook - that is it will set serviceJoined on the SharedNotebook and create a LinkedNotebook on the recipient's account pointing to the SharedNotebook. The LinkedNotebook creation happens out-of-band, so there will be a delay on the order of half a minute between the SharedNotebook and LinkedNotebook creation.
Also handles sending an email to the email addresses: if a SharedNotebook is being created, this will send the shared notebook invite email, and if a SharedNotebook already exists, it will send the shared notebook reminder email. Both these emails contain a link to join the notebook. If the notebook is being auto-joined, it sends an email with that information to the recipient.
authenticationToken | Must be an authentication token from the owner or a shared notebook authentication token or business authentication token with sufficient permissions to change invitations for a notebook. |
sharedNotebook | A shared notebook object populated with the email address of the share recipient, the notebook guid and the access permissions. All other attributes of the shared object are ignored. The SharedNotebook.allowPreview field must be explicitly set with either a true or false value. |
message | The sharer-defined message to put in the email sent out. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of shareNotebook
|
pure virtual |
If this note is shared publicly then this will stop sharing that note and invalidate its "Note Key", so any existing URLs to access that Note will stop working.
If the Note is not shared, then this function will do nothing.
This function does not remove individual shares for the note. To remove individual shares, see stopSharingNoteWithRecipients.
guid | The GUID of the note to be un-shared. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of stopSharingNote
|
pure virtual |
Remove an entry identified by 'key' from the applicationData map for the note identified by 'guid'. Silently ignores an unset of a non-existing key.
|
pure virtual |
Asynchronous version of unsetNoteApplicationDataEntry
|
pure virtual |
Remove an entry identified by 'key' from the applicationData map for the Resource identified by 'guid'.
|
pure virtual |
Asynchronous version of unsetResourceApplicationDataEntry
|
pure virtual |
Removes the provided tag from every note that is currently tagged with this tag. If this operation is successful, the tag will still be in the account, but it will not be tagged on any notes.
This function is not indended for use by full synchronizing clients, since it does not provide enough result information to the client to reconcile the local state without performing a follow-up sync from the service. This is intended for "thin clients" that need to efficiently support this as a UI operation.
guid | The GUID of the tag to remove from all notes. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of untagAll
|
pure virtual |
linkedNotebook | Updates the name of a linked notebook. |
EDAMUserException |
|
|
pure virtual |
Asynchronous version of updateLinkedNotebook
|
pure virtual |
Submit a set of changes to a note to the service. The provided data must include the note's guid field for identification. The note's title must also be set.
note | A Note object containing the desired fields to be populated on the service. With the exception of the note's title and guid, fields that are not being changed do not need to be set. If the content is not being modified, note.content should be left unset. If the list of resources is not being modified, note.resources should be left unset. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of updateNote
|
pure virtual |
Submits notebook changes to the service. The provided data must include the notebook's guid field for identification.
The Notebook will be moved to the specified Workspace, if a non empty Notebook.workspaceGuid is provided. If an empty Notebook.workspaceGuid is set and the Notebook is in a Workspace, then it will be removed from the Workspace and a full access SharedNotebook record will be ensured for the caller. If the caller does not already have a full access share, either the privilege of an existing share will be upgraded or a new share will be created. It is illegal to set a Notebook.workspaceGuid on a Workspace backing Notebook.
notebook | The notebook object containing the requested changes. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of updateNotebook
|
pure virtual |
Perform the same operation as updateNote() would provided that the update sequence number on the parameter Note object matches the current update sequence number that the service has for the note. If they do not match, then no update is performed and the return value will have the current server state in the note field and updated will be false. If the update sequence numbers between the client and server do match, then the note will be updated and the note field of the return value will be returned as it would be for the updateNote method. This method allows you to check for an update to the note on the service, by another client instance, from when you obtained the note state as a baseline for your edits and the time when you wish to save your edits. If your client can merge the conflict, you can avoid overwriting changes that were saved to the service by the other client.
See the updateNote method for information on the exceptions and parameters for this method. The only difference is that you must have an update sequence number defined on the note parameter (equal to the USN of the note as synched to the client), and the following additional exceptions might be thrown.
EDAMUserException |
|
|
pure virtual |
Asynchronous version of updateNoteIfUsnMatches
|
pure virtual |
Submit a set of changes to a resource to the service. This can be used to update the meta-data about the resource, but cannot be used to change the binary contents of the resource (including the length and hash). These cannot be changed directly without creating a new resource and removing the old one via updateNote.
resource | A Resource object containing the desired fields to be populated on the service. The service will attempt to update the resource with the following fields from the client:
|
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of updateResource
|
pure virtual |
Submits search changes to the service. The provided data must include the search's guid field for identification. The service will apply updates to the following search fields: name, query, and scope.
search | The search object containing the requested changes. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of updateSearch
|
pure virtual |
@Deprecated See createOrUpdateNotebookShares and manageNotebookShares.
|
pure virtual |
Asynchronous version of updateSharedNotebook
|
pure virtual |
Submits tag changes to the service. The provided data must include the tag's guid field for identification. The service will apply updates to the following tag fields: name, parentGuid
tag | The tag object containing the requested changes. |
EDAMUserException |
|
EDAMNotFoundException |
|
|
pure virtual |
Asynchronous version of updateTag