com.evernote.edam.notestore
Interface NoteStore.Iface

All Known Implementing Classes:
NoteStore.Client
Enclosing class:
NoteStore

public static interface NoteStore.Iface

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.

All functions take an "authenticationToken" parameter, which is the value returned by the UserStore which permits access to the account. This parameter is mandatory for all functions.

Calls which require an authenticationToken may throw an EDAMUserException for the following reasons:


Method Summary
 AuthenticationResult authenticateToSharedNotebook(java.lang.String shareKey, java.lang.String authenticationToken)
          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.
 Note copyNote(java.lang.String authenticationToken, java.lang.String noteGuid, java.lang.String toNotebookGuid)
          Performs a deep copy of the Note with the provided GUID 'noteGuid' into the Notebook with the provided GUID 'toNotebookGuid'.
 LinkedNotebook createLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook)
          Asks the service to make a linked notebook with the provided name, username of the owner and identifiers provided.
 Note createNote(java.lang.String authenticationToken, Note note)
          Asks the service to make a note with the provided set of information.
 Notebook createNotebook(java.lang.String authenticationToken, Notebook notebook)
          Asks the service to make a notebook with the provided name.
 SavedSearch createSearch(java.lang.String authenticationToken, SavedSearch search)
          Asks the service to make a saved search with a set of information.
 SharedNotebook createSharedNotebook(java.lang.String authenticationToken, SharedNotebook sharedNotebook)
          Used to construct a shared notebook object.
 Tag createTag(java.lang.String authenticationToken, Tag tag)
          Asks the service to make a tag with a set of information.
 int deleteNote(java.lang.String authenticationToken, java.lang.String guid)
          Moves the note into the trash.
 void emailNote(java.lang.String authenticationToken, NoteEmailParameters parameters)
          Attempts to send a single note to one or more email recipients.
 int expungeInactiveNotes(java.lang.String authenticationToken)
          Permanently removes all of the Notes that are currently marked as inactive.
 int expungeLinkedNotebook(java.lang.String authenticationToken, long linkedNotebookId)
          Permanently expunges the linked notebook from the account.
 int expungeNote(java.lang.String authenticationToken, java.lang.String guid)
          Permanently removes the Note, and all of its Resources, from the service.
 int expungeNotebook(java.lang.String authenticationToken, java.lang.String guid)
          Permanently removes the notebook from the user's account.
 int expungeNotes(java.lang.String authenticationToken, java.util.List<java.lang.String> noteGuids)
          Permanently removes a list of Notes, and all of their Resources, from the service.
 int expungeSearch(java.lang.String authenticationToken, java.lang.String guid)
          Permanently deletes the search with the provided GUID, if present.
 int expungeSharedNotebooks(java.lang.String authenticationToken, java.util.List<java.lang.Long> sharedNotebookIds)
          Expunges the SharedNotebooks in the user's account using the SharedNotebook.id as the identifier.
 int expungeTag(java.lang.String authenticationToken, java.lang.String guid)
          Permanently deletes the tag with the provided GUID, if present.
 NoteCollectionCounts findNoteCounts(java.lang.String authenticationToken, NoteFilter filter, boolean withTrash)
          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.
 NoteList findNotes(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes)
          Used to find a set of the notes from a user's account based on various criteria specified via a NoteFilter object.
 long getAccountSize(java.lang.String authenticationToken)
          Deprecated. - This function is deprecated, and should no longer be used. This will always return a value of '0'.
 java.util.List<Ad> getAds(java.lang.String authenticationToken, AdParameters adParameters)
          Clients should make this call once per day to receive a bundle of ads that will be displayed for the subsequent 24 hour period.
 Notebook getDefaultNotebook(java.lang.String authenticationToken)
          Returns the notebook that should be used to store new notes in the user's account when no other notebooks are specified.
 Note getNote(java.lang.String authenticationToken, java.lang.String guid, boolean withContent, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData)
          Returns the current state of the note in the service with the provided GUID.
 Notebook getNotebook(java.lang.String authenticationToken, java.lang.String guid)
          Returns the current state of the notebook with the provided GUID.
 java.lang.String getNoteContent(java.lang.String authenticationToken, java.lang.String guid)
          Returns XHTML contents of the note with the provided GUID.
 java.lang.String getNoteSearchText(java.lang.String authenticationToken, java.lang.String guid)
          Returns a block of the extracted plain text contents of the note with the provided GUID.
 java.util.List<java.lang.String> getNoteTagNames(java.lang.String authenticationToken, java.lang.String guid)
          Returns a list of the names of the tags for the note with the provided guid.
 Note getNoteVersion(java.lang.String authenticationToken, java.lang.String noteGuid, int updateSequenceNum, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData)
          This can be used to retrieve a previous version of a Note after it has been updated within the service.
 Notebook getPublicNotebook(int userId, java.lang.String publicUri)
          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.
 Ad getRandomAd(java.lang.String authenticationToken, AdParameters adParameters)
          A thin client should make this call to retrieve a single random ad for immediate display.
 Resource getResource(java.lang.String authenticationToken, java.lang.String guid, boolean withData, boolean withRecognition, boolean withAttributes, boolean withAlternateData)
          Returns the current state of the resource in the service with the provided GUID.
 byte[] getResourceAlternateData(java.lang.String authenticationToken, java.lang.String guid)
          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.
 ResourceAttributes getResourceAttributes(java.lang.String authenticationToken, java.lang.String guid)
          Returns the set of attributes for the Resource with the provided GUID.
 Resource getResourceByHash(java.lang.String authenticationToken, java.lang.String noteGuid, byte[] contentHash, boolean withData, boolean withRecognition, boolean withAlternateData)
          Returns the current state of a resource, referenced by containing note GUID and resource content hash.
 byte[] getResourceData(java.lang.String authenticationToken, java.lang.String guid)
          Returns binary data of the resource with the provided GUID.
 byte[] getResourceRecognition(java.lang.String authenticationToken, java.lang.String guid)
          Returns the binary contents of the recognition index for the resource with the provided GUID.
 SavedSearch getSearch(java.lang.String authenticationToken, java.lang.String guid)
          Returns the current state of the search with the provided GUID.
 SharedNotebook getSharedNotebookByAuth(java.lang.String authenticationToken)
          This function is used to retrieve extended information about a shared notebook by a guest who has already authenticated to access that notebook.
 SyncChunk getSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, boolean fullSyncOnly)
          Asks the NoteStore to provide the state of the account in order of last modification.
 SyncState getSyncState(java.lang.String authenticationToken)
          Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token.
 Tag getTag(java.lang.String authenticationToken, java.lang.String guid)
          Returns the current state of the Tag with the provided GUID.
 java.util.List<LinkedNotebook> listLinkedNotebooks(java.lang.String authenticationToken)
          Returns a list of linked notebooks
 java.util.List<Notebook> listNotebooks(java.lang.String authenticationToken)
          Returns a list of all of the notebooks in the account.
 java.util.List<NoteVersionId> listNoteVersions(java.lang.String authenticationToken, java.lang.String noteGuid)
          Returns a list of the prior versions of a particular note that are saved within the service.
 java.util.List<SavedSearch> listSearches(java.lang.String authenticationToken)
          Returns a list of the searches in the account.
 java.util.List<SharedNotebook> listSharedNotebooks(java.lang.String authenticationToken)
          Lists the collection of shared notebooks for all notebooks in the users account.
 java.util.List<Tag> listTags(java.lang.String authenticationToken)
          Returns a list of the tags in the account.
 java.util.List<Tag> listTagsByNotebook(java.lang.String authenticationToken, java.lang.String notebookGuid)
          Returns a list of the tags that are applied to at least one note within the provided notebook.
 void untagAll(java.lang.String authenticationToken, java.lang.String guid)
          Removes the provided tag from every note that is currently tagged with this tag.
 LinkedNotebook updateLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook)
           
 Note updateNote(java.lang.String authenticationToken, Note note)
          Submit a set of changes to a note to the service.
 int updateNotebook(java.lang.String authenticationToken, Notebook notebook)
          Submits notebook changes to the service.
 int updateResource(java.lang.String authenticationToken, Resource resource)
          Submit a set of changes to a resource to the service.
 int updateSearch(java.lang.String authenticationToken, SavedSearch search)
          Submits search changes to the service.
 int updateTag(java.lang.String authenticationToken, Tag tag)
          Submits tag changes to the service.
 

Method Detail

getSyncState

SyncState getSyncState(java.lang.String authenticationToken)
                       throws EDAMUserException,
                              EDAMSystemException,
                              org.apache.thrift.TException
Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token.

Parameters:
authenticationToken -
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

getSyncChunk

SyncChunk getSyncChunk(java.lang.String authenticationToken,
                       int afterUSN,
                       int maxEntries,
                       boolean fullSyncOnly)
                       throws EDAMUserException,
                              EDAMSystemException,
                              org.apache.thrift.TException
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.

Parameters:
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.
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.
authenticationToken -
afterUSN -
maxEntries -
fullSyncOnly -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "afterUSN" - if negative
  • BAD_DATA_FORMAT "maxEntries" - if less than 1
EDAMSystemException
org.apache.thrift.TException

listNotebooks

java.util.List<Notebook> listNotebooks(java.lang.String authenticationToken)
                                       throws EDAMUserException,
                                              EDAMSystemException,
                                              org.apache.thrift.TException
Returns a list of all of the notebooks in the account.

Parameters:
authenticationToken -
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

getNotebook

Notebook getNotebook(java.lang.String authenticationToken,
                     java.lang.String guid)
                     throws EDAMUserException,
                            EDAMSystemException,
                            EDAMNotFoundException,
                            org.apache.thrift.TException
Returns the current state of the notebook with the provided GUID. The notebook may be active or deleted (but not expunged).

Parameters:
guid - The GUID of the notebook to be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Notebook.guid" - if the parameter is missing
  • PERMISSION_DENIED "Notebook" - private notebook, user doesn't own
EDAMNotFoundException -
  • "Notebook.guid" - tag not found, by GUID
EDAMSystemException
org.apache.thrift.TException

getDefaultNotebook

Notebook getDefaultNotebook(java.lang.String authenticationToken)
                            throws EDAMUserException,
                                   EDAMSystemException,
                                   org.apache.thrift.TException
Returns the notebook that should be used to store new notes in the user's account when no other notebooks are specified.

Parameters:
authenticationToken -
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

createNotebook

Notebook createNotebook(java.lang.String authenticationToken,
                        Notebook notebook)
                        throws EDAMUserException,
                               EDAMSystemException,
                               org.apache.thrift.TException
Asks the service to make a notebook with the provided name.

Parameters:
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.
authenticationToken -
notebook -
Returns:
The newly created Notebook. The server-side GUID will be saved in this object's 'guid' field.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Notebook.name" - invalid length or pattern
  • BAD_DATA_FORMAT "Publishing.uri" - if publishing set but bad uri
  • BAD_DATA_FORMAT "Publishing.publicDescription" - if too long
  • DATA_CONFLICT "Notebook.name" - name already in use
  • DATA_CONFLICT "Publishing.uri" - if URI already in use
  • DATA_REQUIRED "Publishing.uri" - if publishing set but uri missing
  • LIMIT_REACHED "Notebook" - at max number of notebooks
EDAMSystemException
org.apache.thrift.TException

updateNotebook

int updateNotebook(java.lang.String authenticationToken,
                   Notebook notebook)
                   throws EDAMUserException,
                          EDAMSystemException,
                          EDAMNotFoundException,
                          org.apache.thrift.TException
Submits notebook changes to the service. The provided data must include the notebook's guid field for identification.

Parameters:
notebook - The notebook object containing the requested changes.
authenticationToken -
notebook -
Returns:
The Update Sequence Number for this change within the account.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Notebook.name" - invalid length or pattern
  • BAD_DATA_FORMAT "Publishing.uri" - if publishing set but bad uri
  • BAD_DATA_FORMAT "Publishing.publicDescription" - if too long
  • DATA_CONFLICT "Notebook.name" - name already in use
  • DATA_CONFLICT "Publishing.uri" - if URI already in use
  • DATA_REQUIRED "Publishing.uri" - if publishing set but uri missing
EDAMNotFoundException -
  • "Notebook.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

expungeNotebook

int expungeNotebook(java.lang.String authenticationToken,
                    java.lang.String guid)
                    throws EDAMUserException,
                           EDAMSystemException,
                           EDAMNotFoundException,
                           org.apache.thrift.TException
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).

Parameters:
guid - The GUID of the notebook to delete.
authenticationToken -
guid -
Returns:
The Update Sequence Number for this change within the account.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Notebook.guid" - if the parameter is missing
  • LIMIT_REACHED "Notebook" - trying to expunge the last Notebook
  • PERMISSION_DENIED "Notebook" - private notebook, user doesn't own
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException

listTags

java.util.List<Tag> listTags(java.lang.String authenticationToken)
                             throws EDAMUserException,
                                    EDAMSystemException,
                                    org.apache.thrift.TException
Returns a list of the tags in the account. Evernote does not support the undeletion of tags, so this will only include active tags.

Parameters:
authenticationToken -
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

listTagsByNotebook

java.util.List<Tag> listTagsByNotebook(java.lang.String authenticationToken,
                                       java.lang.String notebookGuid)
                                       throws EDAMUserException,
                                              EDAMSystemException,
                                              EDAMNotFoundException,
                                              org.apache.thrift.TException
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.

Parameters:
notebookGuid - the GUID of the notebook to use to find tags
authenticationToken -
notebookGuid -
Throws:
EDAMNotFoundException -
  • "Notebook.guid" - notebook not found by GUID
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

getTag

Tag getTag(java.lang.String authenticationToken,
           java.lang.String guid)
           throws EDAMUserException,
                  EDAMSystemException,
                  EDAMNotFoundException,
                  org.apache.thrift.TException
Returns the current state of the Tag with the provided GUID.

Parameters:
guid - The GUID of the tag to be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Tag.guid" - if the parameter is missing
  • PERMISSION_DENIED "Tag" - private Tag, user doesn't own
EDAMNotFoundException -
  • "Tag.guid" - tag not found, by GUID
EDAMSystemException
org.apache.thrift.TException

createTag

Tag createTag(java.lang.String authenticationToken,
              Tag tag)
              throws EDAMUserException,
                     EDAMSystemException,
                     EDAMNotFoundException,
                     org.apache.thrift.TException
Asks the service to make a tag with a set of information.

Parameters:
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.
authenticationToken -
tag -
Returns:
The newly created Tag. The server-side GUID will be saved in this object.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Tag.name" - invalid length or pattern
  • BAD_DATA_FORMAT "Tag.parentGuid" - malformed GUID
  • DATA_CONFLICT "Tag.name" - name already in use
  • LIMIT_REACHED "Tag" - at max number of tags
EDAMNotFoundException -
  • "Tag.parentGuid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

updateTag

int updateTag(java.lang.String authenticationToken,
              Tag tag)
              throws EDAMUserException,
                     EDAMSystemException,
                     EDAMNotFoundException,
                     org.apache.thrift.TException
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

Parameters:
tag - The tag object containing the requested changes.
authenticationToken -
tag -
Returns:
The Update Sequence Number for this change within the account.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Tag.name" - invalid length or pattern
  • BAD_DATA_FORMAT "Tag.parentGuid" - malformed GUID
  • DATA_CONFLICT "Tag.name" - name already in use
  • DATA_CONFLICT "Tag.parentGuid" - can't set parent: circular
  • PERMISSION_DENIED "Tag" - user doesn't own tag
EDAMNotFoundException -
  • "Tag.guid" - tag not found, by GUID
  • "Tag.parentGuid" - parent not found, by GUID
EDAMSystemException
org.apache.thrift.TException

untagAll

void untagAll(java.lang.String authenticationToken,
              java.lang.String guid)
              throws EDAMUserException,
                     EDAMSystemException,
                     EDAMNotFoundException,
                     org.apache.thrift.TException
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.

Parameters:
guid - The GUID of the tag to remove from all notes.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Tag.guid" - if the guid parameter is missing
  • PERMISSION_DENIED "Tag" - user doesn't own tag
EDAMNotFoundException -
  • "Tag.guid" - tag not found, by GUID
EDAMSystemException
org.apache.thrift.TException

expungeTag

int expungeTag(java.lang.String authenticationToken,
               java.lang.String guid)
               throws EDAMUserException,
                      EDAMSystemException,
                      EDAMNotFoundException,
                      org.apache.thrift.TException
Permanently deletes the tag with the provided GUID, if present.

Parameters:
guid - The GUID of the tag to delete.
authenticationToken -
guid -
Returns:
The Update Sequence Number for this change within the account.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Tag.guid" - if the guid parameter is missing
  • PERMISSION_DENIED "Tag" - user doesn't own tag
EDAMNotFoundException -
  • "Tag.guid" - tag not found, by GUID
EDAMSystemException
org.apache.thrift.TException

listSearches

java.util.List<SavedSearch> listSearches(java.lang.String authenticationToken)
                                         throws EDAMUserException,
                                                EDAMSystemException,
                                                org.apache.thrift.TException
Returns a list of the searches in the account. Evernote does not support the undeletion of searches, so this will only include active searches.

Parameters:
authenticationToken -
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

getSearch

SavedSearch getSearch(java.lang.String authenticationToken,
                      java.lang.String guid)
                      throws EDAMUserException,
                             EDAMSystemException,
                             EDAMNotFoundException,
                             org.apache.thrift.TException
Returns the current state of the search with the provided GUID.

Parameters:
guid - The GUID of the search to be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "SavedSearch.guid" - if the parameter is missing
  • PERMISSION_DENIED "SavedSearch" - private Tag, user doesn't own
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException

createSearch

SavedSearch createSearch(java.lang.String authenticationToken,
                         SavedSearch search)
                         throws EDAMUserException,
                                EDAMSystemException,
                                org.apache.thrift.TException
Asks the service to make a saved search with a set of information.

Parameters:
search - The desired list of fields for the search are specified in this object. The caller must specify the name, query, and format of the search.
authenticationToken -
search -
Returns:
The newly created SavedSearch. The server-side GUID will be saved in this object.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "SavedSearch.name" - invalid length or pattern
  • BAD_DATA_FORMAT "SavedSearch.query" - invalid length
  • BAD_DATA_FORMAT "SavedSearch.format" - not a valid QueryFormat value
  • DATA_CONFLICT "SavedSearch.name" - name already in use
  • LIMIT_REACHED "SavedSearch" - at max number of searches
EDAMSystemException
org.apache.thrift.TException

updateSearch

int updateSearch(java.lang.String authenticationToken,
                 SavedSearch search)
                 throws EDAMUserException,
                        EDAMSystemException,
                        EDAMNotFoundException,
                        org.apache.thrift.TException
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 format

Parameters:
search - The search object containing the requested changes.
authenticationToken -
search -
Returns:
The Update Sequence Number for this change within the account.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "SavedSearch.name" - invalid length or pattern
  • BAD_DATA_FORMAT "SavedSearch.query" - invalid length
  • BAD_DATA_FORMAT "SavedSearch.format" - not a valid QueryFormat value
  • DATA_CONFLICT "SavedSearch.name" - name already in use
  • PERMISSION_DENIED "SavedSearch" - user doesn't own tag
EDAMNotFoundException -
  • "SavedSearch.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

expungeSearch

int expungeSearch(java.lang.String authenticationToken,
                  java.lang.String guid)
                  throws EDAMUserException,
                         EDAMSystemException,
                         EDAMNotFoundException,
                         org.apache.thrift.TException
Permanently deletes the search with the provided GUID, if present.

Parameters:
guid - The GUID of the search to delete.
authenticationToken -
guid -
Returns:
The Update Sequence Number for this change within the account.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "SavedSearch.guid" - if the guid parameter is empty
  • PERMISSION_DENIED "SavedSearch" - user doesn't own
EDAMNotFoundException -
  • "SavedSearch.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

findNotes

NoteList findNotes(java.lang.String authenticationToken,
                   NoteFilter filter,
                   int offset,
                   int maxNotes)
                   throws EDAMUserException,
                          EDAMSystemException,
                          EDAMNotFoundException,
                          org.apache.thrift.TException
Used to find a set of the notes from a user's account based on various criteria specified via a NoteFilter object. The Notes (and any embedded Resources) will have empty Data bodies for contents, resource data, and resource recognition fields. These values must be retrieved individually.

Parameters:
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 most notes to return in this query. The service will either return this many notes or the end of the notebook, whichever is shorter.
authenticationToken -
filter -
offset -
maxNotes -
Returns:
The list of notes that match the criteria.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "offset" - not between 0 and EDAM_USER_NOTES_MAX
  • BAD_DATA_FORMAT "maxNotes" - not between 0 and EDAM_USER_NOTES_MAX
  • BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed
  • BAD_DATA_FORMAT "NoteFilter.tagGuids" - if any are malformed
  • BAD_DATA_FORMAT "NoteFilter.words" - if search string too long
  • EDAMNotFoundException -
    • "Notebook.guid" - not found, by GUID
    EDAMSystemException
    org.apache.thrift.TException

findNoteCounts

NoteCollectionCounts findNoteCounts(java.lang.String authenticationToken,
                                    NoteFilter filter,
                                    boolean withTrash)
                                    throws EDAMUserException,
                                           EDAMSystemException,
                                           EDAMNotFoundException,
                                           org.apache.thrift.TException
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).

Parameters:
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.
authenticationToken -
filter -
withTrash -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed
  • BAD_DATA_FORMAT "NoteFilter.notebookGuids" - if any are malformed
  • BAD_DATA_FORMAT "NoteFilter.words" - if search string too long
  • EDAMNotFoundException -
    • "Notebook.guid" - not found, by GUID
    EDAMSystemException
    org.apache.thrift.TException

getNote

Note getNote(java.lang.String authenticationToken,
             java.lang.String guid,
             boolean withContent,
             boolean withResourcesData,
             boolean withResourcesRecognition,
             boolean withResourcesAlternateData)
             throws EDAMUserException,
                    EDAMSystemException,
                    EDAMNotFoundException,
                    org.apache.thrift.TException
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 contents of the resources and their recognition data will be omitted. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).

Parameters:
guid - The GUID of the note to be retrieved.
withContent - If true, the note will include the ENML contents of its 'content' field.
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.
authenticationToken -
guid -
withContent -
withResourcesData -
withResourcesRecognition -
withResourcesAlternateData -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Note.guid" - if the parameter is missing
  • PERMISSION_DENIED "Note" - private note, user doesn't own
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

getNoteContent

java.lang.String getNoteContent(java.lang.String authenticationToken,
                                java.lang.String guid)
                                throws EDAMUserException,
                                       EDAMSystemException,
                                       EDAMNotFoundException,
                                       org.apache.thrift.TException
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).

Parameters:
guid - The GUID of the note to be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Note.guid" - if the parameter is missing
  • PERMISSION_DENIED "Note" - private note, user doesn't own
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

getNoteSearchText

java.lang.String getNoteSearchText(java.lang.String authenticationToken,
                                   java.lang.String guid)
                                   throws EDAMUserException,
                                          EDAMSystemException,
                                          EDAMNotFoundException,
                                          org.apache.thrift.TException
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).

Parameters:
guid - The GUID of the note to be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Note.guid" - if the parameter is missing
  • PERMISSION_DENIED "Note" - private note, user doesn't own
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

getNoteTagNames

java.util.List<java.lang.String> getNoteTagNames(java.lang.String authenticationToken,
                                                 java.lang.String guid)
                                                 throws EDAMUserException,
                                                        EDAMSystemException,
                                                        EDAMNotFoundException,
                                                        org.apache.thrift.TException
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.

Parameters:
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Note.guid" - if the parameter is missing
  • PERMISSION_DENIED "Note" - private note, user doesn't own
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

createNote

Note createNote(java.lang.String authenticationToken,
                Note note)
                throws EDAMUserException,
                       EDAMSystemException,
                       EDAMNotFoundException,
                       org.apache.thrift.TException
Asks the service to make a note with the provided set of information.

Parameters:
note - A Note object containing the desired fields to be populated on the service.
authenticationToken -
note -
Returns:
The newly created Note from the service. The server-side GUIDs for the Note and any Resources will be saved in this object.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Note.title" - invalid length or pattern
  • BAD_DATA_FORMAT "Note.content" - invalid length for ENML content
  • BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type
  • BAD_DATA_FORMAT "NoteAttributes.*" - bad resource string
  • BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string
  • DATA_CONFLICT "Note.deleted" - deleted time set on active note
  • DATA_REQUIRED "Resource.data" - resource data body missing
  • ENML_VALIDATION "*" - note content doesn't validate against DTD
  • LIMIT_REACHED "Note" - at max number per account
  • LIMIT_REACHED "Note.size" - total note size too large
  • LIMIT_REACHED "Note.resources" - too many resources on Note
  • LIMIT_REACHED "Note.tagGuids" - too many Tags on Note
  • LIMIT_REACHED "Resource.data.size" - resource too large
  • LIMIT_REACHED "NoteAttribute.*" - attribute string too long
  • LIMIT_REACHED "ResourceAttribute.*" - attribute string too long
  • PERMISSION_DENIED "Note.notebookGuid" - NB not owned by user
  • QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota
  • BAD_DATA_FORMAT "Tag.name" - Note.tagNames was provided, and one of the specified tags had an invalid length or pattern
  • LIMIT_REACHED "Tag" - Note.tagNames was provided, and the required new tags would exceed the maximum number per account
EDAMNotFoundException -
  • "Note.notebookGuid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

updateNote

Note updateNote(java.lang.String authenticationToken,
                Note note)
                throws EDAMUserException,
                       EDAMSystemException,
                       EDAMNotFoundException,
                       org.apache.thrift.TException
Submit a set of changes to a note to the service. The provided data must include the note's guid field for identification.

Parameters:
note - A Note object containing the desired fields to be populated on the service.
authenticationToken -
note -
Returns:
The metadata (no contents) for the Note on the server after the update
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Note.title" - invalid length or pattern
  • BAD_DATA_FORMAT "Note.content" - invalid length for ENML body
  • BAD_DATA_FORMAT "NoteAttributes.*" - bad resource string
  • BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string
  • BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type
  • DATA_CONFLICT "Note.deleted" - deleted time set on active note
  • DATA_REQUIRED "Resource.data" - resource data body missing
  • ENML_VALIDATION "*" - note content doesn't validate against DTD
  • LIMIT_REACHED "Note.tagGuids" - too many Tags on Note
  • LIMIT_REACHED "Note.resources" - too many resources on Note
  • LIMIT_REACHED "Note.size" - total note size too large
  • LIMIT_REACHED "Resource.data.size" - resource too large
  • LIMIT_REACHED "NoteAttribute.*" - attribute string too long
  • LIMIT_REACHED "ResourceAttribute.*" - attribute string too long
  • PERMISSION_DENIED "Note" - user doesn't own
  • PERMISSION_DENIED "Note.notebookGuid" - user doesn't own destination
  • QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota
  • BAD_DATA_FORMAT "Tag.name" - Note.tagNames was provided, and one of the specified tags had an invalid length or pattern
  • LIMIT_REACHED "Tag" - Note.tagNames was provided, and the required new tags would exceed the maximum number per account
EDAMNotFoundException -
  • "Note.guid" - note not found, by GUID
  • "Note.notebookGuid" - if notebookGuid provided, but not found
EDAMSystemException
org.apache.thrift.TException

deleteNote

int deleteNote(java.lang.String authenticationToken,
               java.lang.String guid)
               throws EDAMUserException,
                      EDAMSystemException,
                      EDAMNotFoundException,
                      org.apache.thrift.TException
Moves the note into the trash. The note may still be undeleted, unless it is expunged. This is equivalent to calling udpateNote() after setting Note.active = false

Parameters:
guid - The GUID of the note to delete.
authenticationToken -
guid -
Returns:
The Update Sequence Number for this change within the account.
Throws:
EDAMUserException -
  • PERMISSION_DENIED "Note" - user doesn't have permission to update the note.
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

expungeNote

int expungeNote(java.lang.String authenticationToken,
                java.lang.String guid)
                throws EDAMUserException,
                       EDAMSystemException,
                       EDAMNotFoundException,
                       org.apache.thrift.TException
Permanently removes the Note, and all of its Resources, from the service.

Parameters:
guid - The GUID of the note to delete.
authenticationToken -
guid -
Returns:
The Update Sequence Number for this change within the account.
Throws:
EDAMUserException -
  • PERMISSION_DENIED "Note" - user doesn't own
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

expungeNotes

int expungeNotes(java.lang.String authenticationToken,
                 java.util.List<java.lang.String> noteGuids)
                 throws EDAMUserException,
                        EDAMSystemException,
                        EDAMNotFoundException,
                        org.apache.thrift.TException
Permanently removes a list of Notes, and all of their Resources, from the service. This should be invoked with a small number of Note GUIDs (e.g. 100 or less) on each call. To expunge a larger number of notes, call this method multiple times. This should also be used to reduce the number of Notes in a notebook before calling expungeNotebook() or in the trash before calling expungeInactiveNotes(), since these calls may be prohibitively slow if there are more than a few hundred notes. If an exception is thrown for any of the GUIDs, then none of the notes will be deleted. I.e. this call can be treated as an atomic transaction.

Parameters:
noteGuids - The list of GUIDs for the Notes to remove.
authenticationToken -
noteGuids -
Returns:
The account's updateCount at the end of this operation
Throws:
EDAMUserException -
  • PERMISSION_DENIED "Note" - user doesn't own
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

expungeInactiveNotes

int expungeInactiveNotes(java.lang.String authenticationToken)
                         throws EDAMUserException,
                                EDAMSystemException,
                                org.apache.thrift.TException
Permanently removes all of the Notes that are currently marked as inactive. This is equivalent to "emptying the trash", and these Notes will be gone permanently.

This operation may be relatively slow if the account contains a large number of inactive Notes.

Parameters:
authenticationToken -
Returns:
The number of notes that were expunged.
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

copyNote

Note copyNote(java.lang.String authenticationToken,
              java.lang.String noteGuid,
              java.lang.String toNotebookGuid)
              throws EDAMUserException,
                     EDAMSystemException,
                     EDAMNotFoundException,
                     org.apache.thrift.TException
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.

Parameters:
noteGuid - The GUID of the Note to copy.
toNotebookGuid - The GUID of the Notebook that should receive the new Note.
authenticationToken -
noteGuid -
toNotebookGuid -
Returns:
The metadata for the new Note that was created. This will include the new GUID for this Note (and any copied Resources), but will not include the content body or the binary bodies of any Resources.
Throws:
EDAMUserException -
  • LIMIT_REACHED "Note" - at max number per account
  • PERMISSION_DENIED "Notebook.guid" - destination not owned by user
  • PERMISSION_DENIED "Note" - user doesn't own
  • QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota
EDAMNotFoundException -
  • "Notebook.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

listNoteVersions

java.util.List<NoteVersionId> listNoteVersions(java.lang.String authenticationToken,
                                               java.lang.String noteGuid)
                                               throws EDAMUserException,
                                                      EDAMSystemException,
                                                      EDAMNotFoundException,
                                                      org.apache.thrift.TException
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.

Parameters:
authenticationToken -
noteGuid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Note.guid" - if the parameter is missing
  • PERMISSION_DENIED "Note" - private note, user doesn't own
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

getNoteVersion

Note getNoteVersion(java.lang.String authenticationToken,
                    java.lang.String noteGuid,
                    int updateSequenceNum,
                    boolean withResourcesData,
                    boolean withResourcesRecognition,
                    boolean withResourcesAlternateData)
                    throws EDAMUserException,
                           EDAMSystemException,
                           EDAMNotFoundException,
                           org.apache.thrift.TException
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.)

Parameters:
guid - 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.
authenticationToken -
noteGuid -
updateSequenceNum -
withResourcesData -
withResourcesRecognition -
withResourcesAlternateData -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Note.guid" - if the parameter is missing
  • PERMISSION_DENIED "Note" - private note, user doesn't own
  • PERMISSION_DENIED "updateSequenceNum" - The account isn't permitted to access previous versions of notes. (i.e. this is a Free account.)
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
  • "Note.updateSequenceNumber" - the Note doesn't have a version with the corresponding USN.
EDAMSystemException
org.apache.thrift.TException

getResource

Resource getResource(java.lang.String authenticationToken,
                     java.lang.String guid,
                     boolean withData,
                     boolean withRecognition,
                     boolean withAttributes,
                     boolean withAlternateData)
                     throws EDAMUserException,
                            EDAMSystemException,
                            EDAMNotFoundException,
                            org.apache.thrift.TException
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).

Parameters:
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.
authenticationToken -
guid -
withData -
withRecognition -
withAttributes -
withAlternateData -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing
  • PERMISSION_DENIED "Resource" - private resource, user doesn't own
EDAMNotFoundException -
  • "Resource.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

updateResource

int updateResource(java.lang.String authenticationToken,
                   Resource resource)
                   throws EDAMUserException,
                          EDAMSystemException,
                          EDAMNotFoundException,
                          org.apache.thrift.TException
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.

Parameters:
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:
  • guid: must be provided to identify the resource
  • mime
  • width
  • height
  • duration
  • recognition: if this is provided, it must include the data body for the resource recognition index data and the recoFormat must be provided. If absent, the recognition on the server won't be changed.
  • attributes: optional. if present, the set of attributes will be replaced.
authenticationToken -
resource -
Returns:
The Update Sequence Number of the resource after the changes have been applied.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing
  • BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type
  • BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string
  • DATA_REQUIRED "Resource.data" - resource data body missing
  • LIMIT_REACHED "ResourceAttribute.*" - attribute string too long
  • PERMISSION_DENIED "Resource" - private resource, user doesn't own
EDAMNotFoundException -
  • "Resource.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

getResourceData

byte[] getResourceData(java.lang.String authenticationToken,
                       java.lang.String guid)
                       throws EDAMUserException,
                              EDAMSystemException,
                              EDAMNotFoundException,
                              org.apache.thrift.TException
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).

Parameters:
guid - The GUID of the resource to be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing
  • PERMISSION_DENIED "Resource" - private resource, user doesn't own
EDAMNotFoundException -
  • "Resource.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

getResourceByHash

Resource getResourceByHash(java.lang.String authenticationToken,
                           java.lang.String noteGuid,
                           byte[] contentHash,
                           boolean withData,
                           boolean withRecognition,
                           boolean withAlternateData)
                           throws EDAMUserException,
                                  EDAMSystemException,
                                  EDAMNotFoundException,
                                  org.apache.thrift.TException
Returns the current state of a resource, referenced by containing note GUID and resource content hash.

Parameters:
noteGuid - The GUID of the note that holds the resource to be retrieved.
contentHash - The MD5 checksum of the resource within that note.
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.
authenticationToken -
noteGuid -
contentHash -
withData -
withRecognition -
withAlternateData -
Throws:
EDAMUserException -
  • DATA_REQUIRED "Note.guid" - noteGuid param missing
  • DATA_REQUIRED "Note.contentHash" - contentHash param missing
  • PERMISSION_DENIED "Resource" - private resource, user doesn't own
EDAMNotFoundException -
  • "Note" - not found, by guid
  • "Resource" - not found, by hash
EDAMSystemException
org.apache.thrift.TException

getResourceRecognition

byte[] getResourceRecognition(java.lang.String authenticationToken,
                              java.lang.String guid)
                              throws EDAMUserException,
                                     EDAMSystemException,
                                     EDAMNotFoundException,
                                     org.apache.thrift.TException
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).

Parameters:
guid - The GUID of the resource whose recognition data should be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing
  • PERMISSION_DENIED "Resource" - private resource, user doesn't own
EDAMNotFoundException -
  • "Resource.guid" - not found, by GUID
  • "Resource.recognition" - resource has no recognition
EDAMSystemException
org.apache.thrift.TException

getResourceAlternateData

byte[] getResourceAlternateData(java.lang.String authenticationToken,
                                java.lang.String guid)
                                throws EDAMUserException,
                                       EDAMSystemException,
                                       EDAMNotFoundException,
                                       org.apache.thrift.TException
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.

Parameters:
guid - The GUID of the resource whose recognition data should be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing
  • PERMISSION_DENIED "Resource" - private resource, user doesn't own
EDAMNotFoundException -
  • "Resource.guid" - not found, by GUID
  • "Resource.alternateData" - resource has no recognition
EDAMSystemException
org.apache.thrift.TException

getResourceAttributes

ResourceAttributes getResourceAttributes(java.lang.String authenticationToken,
                                         java.lang.String guid)
                                         throws EDAMUserException,
                                                EDAMSystemException,
                                                EDAMNotFoundException,
                                                org.apache.thrift.TException
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).

Parameters:
guid - The GUID of the resource whose attributes should be retrieved.
authenticationToken -
guid -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing
  • PERMISSION_DENIED "Resource" - private resource, user doesn't own
EDAMNotFoundException -
  • "Resource.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException

getAccountSize

long getAccountSize(java.lang.String authenticationToken)
                    throws EDAMUserException,
                           EDAMSystemException,
                           org.apache.thrift.TException
Deprecated. - This function is deprecated, and should no longer be used. This will always return a value of '0'.

Parameters:
authenticationToken -
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

getAds

java.util.List<Ad> getAds(java.lang.String authenticationToken,
                          AdParameters adParameters)
                          throws EDAMUserException,
                                 EDAMSystemException,
                                 org.apache.thrift.TException
Clients should make this call once per day to receive a bundle of ads that will be displayed for the subsequent 24 hour period.

Parameters:
adParameters - A set of parameters that help the service determine which ads to return.
authenticationToken -
adParameters -
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

getRandomAd

Ad getRandomAd(java.lang.String authenticationToken,
               AdParameters adParameters)
               throws EDAMUserException,
                      EDAMSystemException,
                      org.apache.thrift.TException
A thin client should make this call to retrieve a single random ad for immediate display.

Parameters:
adParameters - A set of parameters to help the service determine which ad to return. The 'impression' field should either be absent (if no ads have been displayed previously), or else it should contain the identifier for the most recently-displayed ad so that the service can give a different ad.
authenticationToken -
adParameters -
Throws:
EDAMUserException
EDAMSystemException
org.apache.thrift.TException

getPublicNotebook

Notebook getPublicNotebook(int userId,
                           java.lang.String publicUri)
                           throws EDAMSystemException,
                                  EDAMNotFoundException,
                                  org.apache.thrift.TException
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.

Parameters:
userId -
publicUri -
Throws:
EDAMNotFoundException -
  • "Publishing.uri" - not found, by URI
EDAMSystemException
org.apache.thrift.TException

createSharedNotebook

SharedNotebook createSharedNotebook(java.lang.String authenticationToken,
                                    SharedNotebook sharedNotebook)
                                    throws EDAMUserException,
                                           EDAMNotFoundException,
                                           EDAMSystemException,
                                           org.apache.thrift.TException
Used to construct a shared notebook object. The constructed notebook will contain a "share key" which serve as a unique identifer and access token for a user to access the notebook of the shared notebook owner.

Parameters:
sharedNotebook - An 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.
authenticationToken -
sharedNotebook -
Returns:
The fully populated SharedNotebook object including the server assigned share id and shareKey which can both the used to uniquely identify the SharedNotebook.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "SharedNotebook.email" - if the email was not valid
EDAMNotFoundException -
  • Notebook.guid - if the notebookGuid is not a valid guid for the user
EDAMSystemException
org.apache.thrift.TException

listSharedNotebooks

java.util.List<SharedNotebook> listSharedNotebooks(java.lang.String authenticationToken)
                                                   throws EDAMUserException,
                                                          EDAMNotFoundException,
                                                          EDAMSystemException,
                                                          org.apache.thrift.TException
Lists the collection of shared notebooks for all notebooks in the users account.

Parameters:
authenticationToken -
Returns:
The list of all SharedNotebooks for the user
Throws:
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException

expungeSharedNotebooks

int expungeSharedNotebooks(java.lang.String authenticationToken,
                           java.util.List<java.lang.Long> sharedNotebookIds)
                           throws EDAMUserException,
                                  EDAMNotFoundException,
                                  EDAMSystemException,
                                  org.apache.thrift.TException
Expunges the SharedNotebooks in the user's account using the SharedNotebook.id as the identifier.

Parameters:
sharedNotebookIds - - a list of ShardNotebook.id longs identifying the objects to delete permanently.
authenticationToken -
sharedNotebookIds -
Returns:
The account's update sequence number.
Throws:
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException

createLinkedNotebook

LinkedNotebook createLinkedNotebook(java.lang.String authenticationToken,
                                    LinkedNotebook linkedNotebook)
                                    throws EDAMUserException,
                                           EDAMNotFoundException,
                                           EDAMSystemException,
                                           org.apache.thrift.TException
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.

Parameters:
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.
authenticationToken -
linkedNotebook -
Returns:
The newly created LinkedNotebook. The server-side id will be saved in this object's 'id' field.
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "LinkedNotebook.name" - invalid length or pattern
  • BAD_DATA_FORMAT "LinkedNotebook.username" - bad username format
  • BAD_DATA_FORMAT "LinkedNotebook.uri" - if public notebook set but bad uri
  • BAD_DATA_FORMAT "LinkedNotebook.shareKey" - if private notebook set but bad shareKey
  • DATA_REQUIRED "LinkedNotebook.shardId" - if private notebook but shard id not provided
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException

updateLinkedNotebook

LinkedNotebook updateLinkedNotebook(java.lang.String authenticationToken,
                                    LinkedNotebook linkedNotebook)
                                    throws EDAMUserException,
                                           EDAMNotFoundException,
                                           EDAMSystemException,
                                           org.apache.thrift.TException
Parameters:
linkedNotebook - Updates the name of a linked notebook.
authenticationToken -
linkedNotebook -
Throws:
EDAMUserException -
  • BAD_DATA_FORMAT "LinkedNotebook.name" - invalid length or pattern
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException

listLinkedNotebooks

java.util.List<LinkedNotebook> listLinkedNotebooks(java.lang.String authenticationToken)
                                                   throws EDAMUserException,
                                                          EDAMNotFoundException,
                                                          EDAMSystemException,
                                                          org.apache.thrift.TException
Returns a list of linked notebooks

Parameters:
authenticationToken -
Throws:
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException

expungeLinkedNotebook

int expungeLinkedNotebook(java.lang.String authenticationToken,
                          long linkedNotebookId)
                          throws EDAMUserException,
                                 EDAMNotFoundException,
                                 EDAMSystemException,
                                 org.apache.thrift.TException
Permanently expunges the linked notebook from the account.

Parameters:
linkedNotebookId - The LinkedNotebook.id field of the LinkedNotebook to permanently remove from the account.
authenticationToken -
linkedNotebookId -
Throws:
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException

authenticateToSharedNotebook

AuthenticationResult authenticateToSharedNotebook(java.lang.String shareKey,
                                                  java.lang.String authenticationToken)
                                                  throws EDAMUserException,
                                                         EDAMNotFoundException,
                                                         EDAMSystemException,
                                                         org.apache.thrift.TException
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.

Parameters:
shareKey - The 'shareKey' identifier from the SharedNotebook that was granted to some recipient. This string internally encodes the notebook identifier and a security signature.
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. This may be required if the notebook was created with 'requireLogin'. If this string is empty, the service will attempt to authenticate to the shared notebook without any logged in user.
shareKey -
authenticationToken -
Throws:
EDAMSystemException -
  • BAD_DATA_FORMAT "shareKey" - invalid shareKey string
  • INVALID_AUTH "shareKey" - bad signature on shareKey string
  • SHARD_UNAVAILABLE - Request went to the wrong shard
EDAMNotFoundException -
  • "SharedNotebook.id" - the shared notebook no longer exists
EDAMUserException -
  • DATA_REQUIRED "authenticationToken" - the share requires login, and no valid authentication token was provided.
  • PERMISSION_DENIED "SharedNotebook.username" - share requires login, and another username has already been bound to this notebook.
org.apache.thrift.TException

getSharedNotebookByAuth

SharedNotebook getSharedNotebookByAuth(java.lang.String authenticationToken)
                                       throws EDAMUserException,
                                              EDAMNotFoundException,
                                              EDAMSystemException,
                                              org.apache.thrift.TException
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.

Parameters:
authenticationToken - Should be the authentication token retrieved from the reply of authenticateToSharedNotebook(), proving access to a particular shared notebook.
authenticationToken -
Throws:
EDAMUserException -
  • PERMISSION_DENIED "authenticationToken" - authentication token doesn't correspond to a valid shared notebook
EDAMNotFoundException -
  • "SharedNotebook.id" - the shared notebook no longer exists
EDAMSystemException
org.apache.thrift.TException

emailNote

void emailNote(java.lang.String authenticationToken,
               NoteEmailParameters parameters)
               throws EDAMUserException,
                      EDAMNotFoundException,
                      EDAMSystemException,
                      org.apache.thrift.TException
Attempts to send a single note to one or more email recipients.

Parameters:
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.
authenticationToken -
parameters -
Throws:
EDAMUserException -
  • LIMIT_REACHED "NoteEmailParameters.toAddresses" - The email can't be sent because this would exceed the user's daily email limit.
  • BAD_DATA_FORMAT "(email address)" - email address malformed
  • DATA_REQUIRED "NoteEmailParameters.toAddresses" - if there are no To: or Cc: addresses provided.
  • DATA_REQUIRED "Note.title" - if the caller provides a Note parameter with no title
  • DATA_REQUIRED "Note.content" - if the caller provides a Note parameter with no content
  • DATA_REQUIRED "NoteEmailParameters.note" - if no guid or note provided
  • PERMISSION_DENIED "Note" - private note, user doesn't own
EDAMNotFoundException -
  • "Note.guid" - not found, by GUID
EDAMSystemException
org.apache.thrift.TException