|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.evernote.edam.notestore.NoteStore.Client
public static class NoteStore.Client
Constructor Summary | |
---|---|
NoteStore.Client(com.evernote.thrift.protocol.TProtocol prot)
|
|
NoteStore.Client(com.evernote.thrift.protocol.TProtocol iprot,
com.evernote.thrift.protocol.TProtocol oprot)
|
Method Summary | |
---|---|
AuthenticationResult |
authenticateToSharedNote(java.lang.String guid,
java.lang.String noteKey,
java.lang.String authenticationToken)
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. |
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,
java.lang.String guid)
Permanently expunges the linked notebook from the account. |
int |
expungeNote(java.lang.String authenticationToken,
java.lang.String guid)
Permanently removes a 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 saved 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. |
int |
findNoteOffset(java.lang.String authenticationToken,
NoteFilter filter,
java.lang.String guid)
Finds the position of a note within a sorted subset of all of the user's notes. |
NoteList |
findNotes(java.lang.String authenticationToken,
NoteFilter filter,
int offset,
int maxNotes)
DEPRECATED. |
NotesMetadataList |
findNotesMetadata(java.lang.String authenticationToken,
NoteFilter filter,
int offset,
int maxNotes,
NotesMetadataResultSpec resultSpec)
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. |
RelatedResult |
findRelated(java.lang.String authenticationToken,
RelatedQuery query,
RelatedResultSpec resultSpec)
Identify related entities on the service, such as notes, notebooks, and tags related to notes or content. |
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. |
SyncChunk |
getFilteredSyncChunk(java.lang.String authenticationToken,
int afterUSN,
int maxEntries,
SyncChunkFilter filter)
Asks the NoteStore to provide the state of the account in order of last modification. |
com.evernote.thrift.protocol.TProtocol |
getInputProtocol()
Get the TProtocol being used as the input (read) protocol. |
SyncChunk |
getLinkedNotebookSyncChunk(java.lang.String authenticationToken,
LinkedNotebook linkedNotebook,
int afterUSN,
int maxEntries,
boolean fullSyncOnly)
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. |
SyncState |
getLinkedNotebookSyncState(java.lang.String authenticationToken,
LinkedNotebook linkedNotebook)
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. |
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. |
LazyMap |
getNoteApplicationData(java.lang.String authenticationToken,
java.lang.String guid)
Get all of the application data for the note identified by GUID, with values returned within the LazyMap fullMap field. |
java.lang.String |
getNoteApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key)
Get the value of a single entry in the applicationData map for the note identified by 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,
boolean noteOnly,
boolean tokenizeForIndexing)
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. |
com.evernote.thrift.protocol.TProtocol |
getOutputProtocol()
Get the TProtocol being used as the output (write) protocol. |
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. |
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. |
LazyMap |
getResourceApplicationData(java.lang.String authenticationToken,
java.lang.String guid)
Get all of the application data for the Resource identified by GUID, with values returned within the LazyMap fullMap field. |
java.lang.String |
getResourceApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key)
Get the value of a single entry in the applicationData map for the Resource identified by GUID. |
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. |
java.lang.String |
getResourceSearchText(java.lang.String authenticationToken,
java.lang.String guid)
Returns a block of the extracted plain text contents of 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)
DEPRECATED - use getFilteredSyncChunk. |
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. |
SyncState |
getSyncStateWithMetrics(java.lang.String authenticationToken,
ClientUsageMetrics clientMetrics)
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. |
AuthenticationResult |
recv_authenticateToSharedNote()
|
AuthenticationResult |
recv_authenticateToSharedNotebook()
|
Note |
recv_copyNote()
|
LinkedNotebook |
recv_createLinkedNotebook()
|
Note |
recv_createNote()
|
Notebook |
recv_createNotebook()
|
SavedSearch |
recv_createSearch()
|
SharedNotebook |
recv_createSharedNotebook()
|
Tag |
recv_createTag()
|
int |
recv_deleteNote()
|
void |
recv_emailNote()
|
int |
recv_expungeInactiveNotes()
|
int |
recv_expungeLinkedNotebook()
|
int |
recv_expungeNote()
|
int |
recv_expungeNotebook()
|
int |
recv_expungeNotes()
|
int |
recv_expungeSearch()
|
int |
recv_expungeSharedNotebooks()
|
int |
recv_expungeTag()
|
NoteCollectionCounts |
recv_findNoteCounts()
|
int |
recv_findNoteOffset()
|
NoteList |
recv_findNotes()
|
NotesMetadataList |
recv_findNotesMetadata()
|
RelatedResult |
recv_findRelated()
|
Notebook |
recv_getDefaultNotebook()
|
SyncChunk |
recv_getFilteredSyncChunk()
|
SyncChunk |
recv_getLinkedNotebookSyncChunk()
|
SyncState |
recv_getLinkedNotebookSyncState()
|
Note |
recv_getNote()
|
LazyMap |
recv_getNoteApplicationData()
|
java.lang.String |
recv_getNoteApplicationDataEntry()
|
Notebook |
recv_getNotebook()
|
java.lang.String |
recv_getNoteContent()
|
java.lang.String |
recv_getNoteSearchText()
|
java.util.List<java.lang.String> |
recv_getNoteTagNames()
|
Note |
recv_getNoteVersion()
|
Notebook |
recv_getPublicNotebook()
|
Resource |
recv_getResource()
|
byte[] |
recv_getResourceAlternateData()
|
LazyMap |
recv_getResourceApplicationData()
|
java.lang.String |
recv_getResourceApplicationDataEntry()
|
ResourceAttributes |
recv_getResourceAttributes()
|
Resource |
recv_getResourceByHash()
|
byte[] |
recv_getResourceData()
|
byte[] |
recv_getResourceRecognition()
|
java.lang.String |
recv_getResourceSearchText()
|
SavedSearch |
recv_getSearch()
|
SharedNotebook |
recv_getSharedNotebookByAuth()
|
SyncChunk |
recv_getSyncChunk()
|
SyncState |
recv_getSyncState()
|
SyncState |
recv_getSyncStateWithMetrics()
|
Tag |
recv_getTag()
|
java.util.List<LinkedNotebook> |
recv_listLinkedNotebooks()
|
java.util.List<Notebook> |
recv_listNotebooks()
|
java.util.List<NoteVersionId> |
recv_listNoteVersions()
|
java.util.List<SavedSearch> |
recv_listSearches()
|
java.util.List<SharedNotebook> |
recv_listSharedNotebooks()
|
java.util.List<Tag> |
recv_listTags()
|
java.util.List<Tag> |
recv_listTagsByNotebook()
|
int |
recv_sendMessageToSharedNotebookMembers()
|
int |
recv_setNoteApplicationDataEntry()
|
int |
recv_setResourceApplicationDataEntry()
|
int |
recv_setSharedNotebookRecipientSettings()
|
java.lang.String |
recv_shareNote()
|
void |
recv_stopSharingNote()
|
int |
recv_unsetNoteApplicationDataEntry()
|
int |
recv_unsetResourceApplicationDataEntry()
|
void |
recv_untagAll()
|
int |
recv_updateLinkedNotebook()
|
Note |
recv_updateNote()
|
int |
recv_updateNotebook()
|
int |
recv_updateResource()
|
int |
recv_updateSearch()
|
int |
recv_updateSharedNotebook()
|
int |
recv_updateTag()
|
void |
send_authenticateToSharedNote(java.lang.String guid,
java.lang.String noteKey,
java.lang.String authenticationToken)
|
void |
send_authenticateToSharedNotebook(java.lang.String shareKey,
java.lang.String authenticationToken)
|
void |
send_copyNote(java.lang.String authenticationToken,
java.lang.String noteGuid,
java.lang.String toNotebookGuid)
|
void |
send_createLinkedNotebook(java.lang.String authenticationToken,
LinkedNotebook linkedNotebook)
|
void |
send_createNote(java.lang.String authenticationToken,
Note note)
|
void |
send_createNotebook(java.lang.String authenticationToken,
Notebook notebook)
|
void |
send_createSearch(java.lang.String authenticationToken,
SavedSearch search)
|
void |
send_createSharedNotebook(java.lang.String authenticationToken,
SharedNotebook sharedNotebook)
|
void |
send_createTag(java.lang.String authenticationToken,
Tag tag)
|
void |
send_deleteNote(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_emailNote(java.lang.String authenticationToken,
NoteEmailParameters parameters)
|
void |
send_expungeInactiveNotes(java.lang.String authenticationToken)
|
void |
send_expungeLinkedNotebook(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_expungeNote(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_expungeNotebook(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_expungeNotes(java.lang.String authenticationToken,
java.util.List<java.lang.String> noteGuids)
|
void |
send_expungeSearch(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_expungeSharedNotebooks(java.lang.String authenticationToken,
java.util.List<java.lang.Long> sharedNotebookIds)
|
void |
send_expungeTag(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_findNoteCounts(java.lang.String authenticationToken,
NoteFilter filter,
boolean withTrash)
|
void |
send_findNoteOffset(java.lang.String authenticationToken,
NoteFilter filter,
java.lang.String guid)
|
void |
send_findNotes(java.lang.String authenticationToken,
NoteFilter filter,
int offset,
int maxNotes)
|
void |
send_findNotesMetadata(java.lang.String authenticationToken,
NoteFilter filter,
int offset,
int maxNotes,
NotesMetadataResultSpec resultSpec)
|
void |
send_findRelated(java.lang.String authenticationToken,
RelatedQuery query,
RelatedResultSpec resultSpec)
|
void |
send_getDefaultNotebook(java.lang.String authenticationToken)
|
void |
send_getFilteredSyncChunk(java.lang.String authenticationToken,
int afterUSN,
int maxEntries,
SyncChunkFilter filter)
|
void |
send_getLinkedNotebookSyncChunk(java.lang.String authenticationToken,
LinkedNotebook linkedNotebook,
int afterUSN,
int maxEntries,
boolean fullSyncOnly)
|
void |
send_getLinkedNotebookSyncState(java.lang.String authenticationToken,
LinkedNotebook linkedNotebook)
|
void |
send_getNote(java.lang.String authenticationToken,
java.lang.String guid,
boolean withContent,
boolean withResourcesData,
boolean withResourcesRecognition,
boolean withResourcesAlternateData)
|
void |
send_getNoteApplicationData(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getNoteApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key)
|
void |
send_getNotebook(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getNoteContent(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getNoteSearchText(java.lang.String authenticationToken,
java.lang.String guid,
boolean noteOnly,
boolean tokenizeForIndexing)
|
void |
send_getNoteTagNames(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getNoteVersion(java.lang.String authenticationToken,
java.lang.String noteGuid,
int updateSequenceNum,
boolean withResourcesData,
boolean withResourcesRecognition,
boolean withResourcesAlternateData)
|
void |
send_getPublicNotebook(int userId,
java.lang.String publicUri)
|
void |
send_getResource(java.lang.String authenticationToken,
java.lang.String guid,
boolean withData,
boolean withRecognition,
boolean withAttributes,
boolean withAlternateData)
|
void |
send_getResourceAlternateData(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getResourceApplicationData(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getResourceApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key)
|
void |
send_getResourceAttributes(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getResourceByHash(java.lang.String authenticationToken,
java.lang.String noteGuid,
byte[] contentHash,
boolean withData,
boolean withRecognition,
boolean withAlternateData)
|
void |
send_getResourceData(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getResourceRecognition(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getResourceSearchText(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getSearch(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_getSharedNotebookByAuth(java.lang.String authenticationToken)
|
void |
send_getSyncChunk(java.lang.String authenticationToken,
int afterUSN,
int maxEntries,
boolean fullSyncOnly)
|
void |
send_getSyncState(java.lang.String authenticationToken)
|
void |
send_getSyncStateWithMetrics(java.lang.String authenticationToken,
ClientUsageMetrics clientMetrics)
|
void |
send_getTag(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_listLinkedNotebooks(java.lang.String authenticationToken)
|
void |
send_listNotebooks(java.lang.String authenticationToken)
|
void |
send_listNoteVersions(java.lang.String authenticationToken,
java.lang.String noteGuid)
|
void |
send_listSearches(java.lang.String authenticationToken)
|
void |
send_listSharedNotebooks(java.lang.String authenticationToken)
|
void |
send_listTags(java.lang.String authenticationToken)
|
void |
send_listTagsByNotebook(java.lang.String authenticationToken,
java.lang.String notebookGuid)
|
void |
send_sendMessageToSharedNotebookMembers(java.lang.String authenticationToken,
java.lang.String notebookGuid,
java.lang.String messageText,
java.util.List<java.lang.String> recipients)
|
void |
send_setNoteApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key,
java.lang.String value)
|
void |
send_setResourceApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key,
java.lang.String value)
|
void |
send_setSharedNotebookRecipientSettings(java.lang.String authenticationToken,
long sharedNotebookId,
SharedNotebookRecipientSettings recipientSettings)
|
void |
send_shareNote(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_stopSharingNote(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_unsetNoteApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key)
|
void |
send_unsetResourceApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key)
|
void |
send_untagAll(java.lang.String authenticationToken,
java.lang.String guid)
|
void |
send_updateLinkedNotebook(java.lang.String authenticationToken,
LinkedNotebook linkedNotebook)
|
void |
send_updateNote(java.lang.String authenticationToken,
Note note)
|
void |
send_updateNotebook(java.lang.String authenticationToken,
Notebook notebook)
|
void |
send_updateResource(java.lang.String authenticationToken,
Resource resource)
|
void |
send_updateSearch(java.lang.String authenticationToken,
SavedSearch search)
|
void |
send_updateSharedNotebook(java.lang.String authenticationToken,
SharedNotebook sharedNotebook)
|
void |
send_updateTag(java.lang.String authenticationToken,
Tag tag)
|
int |
sendMessageToSharedNotebookMembers(java.lang.String authenticationToken,
java.lang.String notebookGuid,
java.lang.String messageText,
java.util.List<java.lang.String> recipients)
Send a reminder message to some or all of the email addresses that a notebook has been shared with. |
int |
setNoteApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key,
java.lang.String value)
Update, or create, an entry in the applicationData map for the note identified by guid. |
int |
setResourceApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key,
java.lang.String value)
Update, or create, an entry in the applicationData map for the Resource identified by guid. |
int |
setSharedNotebookRecipientSettings(java.lang.String authenticationToken,
long sharedNotebookId,
SharedNotebookRecipientSettings recipientSettings)
Set values for the recipient settings associated with a shared notebook. |
java.lang.String |
shareNote(java.lang.String authenticationToken,
java.lang.String guid)
If this note is not already shared (via its own direct URL), then this will start sharing that note. |
void |
stopSharingNote(java.lang.String authenticationToken,
java.lang.String guid)
If this note is not already shared then this will stop sharing that note and invalidate its "Note Key", so any existing URLs to access that Note will stop working. |
int |
unsetNoteApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key)
Remove an entry identified by 'key' from the applicationData map for the note identified by 'guid'. |
int |
unsetResourceApplicationDataEntry(java.lang.String authenticationToken,
java.lang.String guid,
java.lang.String key)
Remove an entry identified by 'key' from the applicationData map for the Resource identified by 'guid'. |
void |
untagAll(java.lang.String authenticationToken,
java.lang.String guid)
Removes the provided tag from every note that is currently tagged with this tag. |
int |
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 |
updateSharedNotebook(java.lang.String authenticationToken,
SharedNotebook sharedNotebook)
Update a SharedNotebook object. |
int |
updateTag(java.lang.String authenticationToken,
Tag tag)
Submits tag changes to the service. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NoteStore.Client(com.evernote.thrift.protocol.TProtocol prot)
public NoteStore.Client(com.evernote.thrift.protocol.TProtocol iprot, com.evernote.thrift.protocol.TProtocol oprot)
Method Detail |
---|
public com.evernote.thrift.protocol.TProtocol getInputProtocol()
com.evernote.thrift.TServiceClient
getInputProtocol
in interface com.evernote.thrift.TServiceClient
public com.evernote.thrift.protocol.TProtocol getOutputProtocol()
com.evernote.thrift.TServiceClient
getOutputProtocol
in interface com.evernote.thrift.TServiceClient
public SyncState getSyncState(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
getSyncState
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_getSyncState(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SyncState recv_getSyncState() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public SyncState getSyncStateWithMetrics(java.lang.String authenticationToken, ClientUsageMetrics clientMetrics) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
getSyncStateWithMetrics
in interface NoteStoreIface
clientMetrics
- see the documentation of the ClientUsageMetrics
structure for an explanation of the fields that clients can pass to
the service.
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_getSyncStateWithMetrics(java.lang.String authenticationToken, ClientUsageMetrics clientMetrics) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SyncState recv_getSyncStateWithMetrics() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public SyncChunk getSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, boolean fullSyncOnly) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
getSyncChunk
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_getSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, boolean fullSyncOnly) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SyncChunk recv_getSyncChunk() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public SyncChunk getFilteredSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, SyncChunkFilter filter) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
getFilteredSyncChunk
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_getFilteredSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, SyncChunkFilter filter) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SyncChunk recv_getFilteredSyncChunk() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public SyncState getLinkedNotebookSyncState(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getLinkedNotebookSyncState
in interface NoteStoreIface
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
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_getLinkedNotebookSyncState(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SyncState recv_getLinkedNotebookSyncState() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public SyncChunk getLinkedNotebookSyncChunk(java.lang.String authenticationToken, LinkedNotebook linkedNotebook, int afterUSN, int maxEntries, boolean fullSyncOnly) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getLinkedNotebookSyncChunk
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_getLinkedNotebookSyncChunk(java.lang.String authenticationToken, LinkedNotebook linkedNotebook, int afterUSN, int maxEntries, boolean fullSyncOnly) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SyncChunk recv_getLinkedNotebookSyncChunk() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.util.List<Notebook> listNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
listNotebooks
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_listNotebooks(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.util.List<Notebook> recv_listNotebooks() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public Notebook getNotebook(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getNotebook
in interface NoteStoreIface
guid
- The GUID of the notebook to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getNotebook(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Notebook recv_getNotebook() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Notebook getDefaultNotebook(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
getDefaultNotebook
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_getDefaultNotebook(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Notebook recv_getDefaultNotebook() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public Notebook createNotebook(java.lang.String authenticationToken, Notebook notebook) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
createNotebook
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_createNotebook(java.lang.String authenticationToken, Notebook notebook) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Notebook recv_createNotebook() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public int updateNotebook(java.lang.String authenticationToken, Notebook notebook) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
updateNotebook
in interface NoteStoreIface
notebook
- The notebook object containing the requested changes.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_updateNotebook(java.lang.String authenticationToken, Notebook notebook) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_updateNotebook() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int expungeNotebook(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
expungeNotebook
in interface NoteStoreIface
guid
- The GUID of the notebook to delete.
EDAMUserException
- EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_expungeNotebook(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_expungeNotebook() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.util.List<Tag> listTags(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
listTags
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_listTags(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.util.List<Tag> recv_listTags() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public java.util.List<Tag> listTagsByNotebook(java.lang.String authenticationToken, java.lang.String notebookGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
listTagsByNotebook
in interface NoteStoreIface
notebookGuid
- the GUID of the notebook to use to find tags
EDAMNotFoundException
- EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_listTagsByNotebook(java.lang.String authenticationToken, java.lang.String notebookGuid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.util.List<Tag> recv_listTagsByNotebook() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Tag getTag(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getTag
in interface NoteStoreIface
guid
- The GUID of the tag to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getTag(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Tag recv_getTag() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Tag createTag(java.lang.String authenticationToken, Tag tag) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
createTag
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_createTag(java.lang.String authenticationToken, Tag tag) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Tag recv_createTag() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int updateTag(java.lang.String authenticationToken, Tag tag) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
updateTag
in interface NoteStoreIface
tag
- The tag object containing the requested changes.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_updateTag(java.lang.String authenticationToken, Tag tag) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_updateTag() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void untagAll(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
untagAll
in interface NoteStoreIface
guid
- The GUID of the tag to remove from all notes.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_untagAll(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public void recv_untagAll() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int expungeTag(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
expungeTag
in interface NoteStoreIface
guid
- The GUID of the tag to delete.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_expungeTag(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_expungeTag() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.util.List<SavedSearch> listSearches(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
listSearches
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_listSearches(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.util.List<SavedSearch> recv_listSearches() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public SavedSearch getSearch(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getSearch
in interface NoteStoreIface
guid
- The GUID of the search to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getSearch(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SavedSearch recv_getSearch() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public SavedSearch createSearch(java.lang.String authenticationToken, SavedSearch search) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
createSearch
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_createSearch(java.lang.String authenticationToken, SavedSearch search) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SavedSearch recv_createSearch() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public int updateSearch(java.lang.String authenticationToken, SavedSearch search) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
updateSearch
in interface NoteStoreIface
search
- The search object containing the requested changes.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_updateSearch(java.lang.String authenticationToken, SavedSearch search) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_updateSearch() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int expungeSearch(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
expungeSearch
in interface NoteStoreIface
guid
- The GUID of the search to delete.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_expungeSearch(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_expungeSearch() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public NoteList findNotes(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
findNotes
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_findNotes(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public NoteList recv_findNotes() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int findNoteOffset(java.lang.String authenticationToken, NoteFilter filter, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
findNoteOffset
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_findNoteOffset(java.lang.String authenticationToken, NoteFilter filter, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_findNoteOffset() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public NotesMetadataList findNotesMetadata(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes, NotesMetadataResultSpec resultSpec) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
findNotesMetadata
in interface NoteStoreIface
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 mximum 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.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
- EDAMSystemException
com.evernote.thrift.TException
public void send_findNotesMetadata(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes, NotesMetadataResultSpec resultSpec) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public NotesMetadataList recv_findNotesMetadata() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public NoteCollectionCounts findNoteCounts(java.lang.String authenticationToken, NoteFilter filter, boolean withTrash) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
findNoteCounts
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_findNoteCounts(java.lang.String authenticationToken, NoteFilter filter, boolean withTrash) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public NoteCollectionCounts recv_findNoteCounts() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Note getNote(java.lang.String authenticationToken, java.lang.String guid, boolean withContent, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getNote
in interface NoteStoreIface
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.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getNote(java.lang.String authenticationToken, java.lang.String guid, boolean withContent, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Note recv_getNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public LazyMap getNoteApplicationData(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getNoteApplicationData
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_getNoteApplicationData(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public LazyMap recv_getNoteApplicationData() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.lang.String getNoteApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getNoteApplicationDataEntry
in interface NoteStoreIface
EDAMNotFoundException
- EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_getNoteApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.lang.String recv_getNoteApplicationDataEntry() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int setNoteApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key, java.lang.String value) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
setNoteApplicationDataEntry
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_setNoteApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key, java.lang.String value) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_setNoteApplicationDataEntry() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int unsetNoteApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
unsetNoteApplicationDataEntry
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_unsetNoteApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_unsetNoteApplicationDataEntry() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.lang.String getNoteContent(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getNoteContent
in interface NoteStoreIface
guid
- The GUID of the note to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getNoteContent(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.lang.String recv_getNoteContent() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.lang.String getNoteSearchText(java.lang.String authenticationToken, java.lang.String guid, boolean noteOnly, boolean tokenizeForIndexing) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getNoteSearchText
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_getNoteSearchText(java.lang.String authenticationToken, java.lang.String guid, boolean noteOnly, boolean tokenizeForIndexing) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.lang.String recv_getNoteSearchText() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.lang.String getResourceSearchText(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResourceSearchText
in interface NoteStoreIface
guid
- The GUID of the resource to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getResourceSearchText(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.lang.String recv_getResourceSearchText() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.util.List<java.lang.String> getNoteTagNames(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getNoteTagNames
in interface NoteStoreIface
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getNoteTagNames(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.util.List<java.lang.String> recv_getNoteTagNames() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Note createNote(java.lang.String authenticationToken, Note note) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
createNote
in interface NoteStoreIface
note
- A Note object containing the desired fields to be populated on
the service.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_createNote(java.lang.String authenticationToken, Note note) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Note recv_createNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Note updateNote(java.lang.String authenticationToken, Note note) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
updateNote
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_updateNote(java.lang.String authenticationToken, Note note) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Note recv_updateNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int deleteNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
deleteNote
in interface NoteStoreIface
guid
- The GUID of the note to delete.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_deleteNote(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_deleteNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int expungeNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
expungeNote
in interface NoteStoreIface
guid
- The GUID of the note to delete.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_expungeNote(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_expungeNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int expungeNotes(java.lang.String authenticationToken, java.util.List<java.lang.String> noteGuids) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
expungeNotes
in interface NoteStoreIface
noteGuids
- The list of GUIDs for the Notes to remove.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_expungeNotes(java.lang.String authenticationToken, java.util.List<java.lang.String> noteGuids) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_expungeNotes() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int expungeInactiveNotes(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
expungeInactiveNotes
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_expungeInactiveNotes(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_expungeInactiveNotes() throws EDAMUserException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public Note copyNote(java.lang.String authenticationToken, java.lang.String noteGuid, java.lang.String toNotebookGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
copyNote
in interface NoteStoreIface
noteGuid
- The GUID of the Note to copy.toNotebookGuid
- The GUID of the Notebook that should receive the new Note.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_copyNote(java.lang.String authenticationToken, java.lang.String noteGuid, java.lang.String toNotebookGuid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Note recv_copyNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.util.List<NoteVersionId> listNoteVersions(java.lang.String authenticationToken, java.lang.String noteGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
listNoteVersions
in interface NoteStoreIface
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_listNoteVersions(java.lang.String authenticationToken, java.lang.String noteGuid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.util.List<NoteVersionId> recv_listNoteVersions() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Note getNoteVersion(java.lang.String authenticationToken, java.lang.String noteGuid, int updateSequenceNum, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getNoteVersion
in interface NoteStoreIface
noteGuid
- The GUID of the note to be retrieved.updateSequenceNum
- The USN of the version of the note that is being retrievedwithResourcesData
- 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
- EDAMSystemException
com.evernote.thrift.TException
public void send_getNoteVersion(java.lang.String authenticationToken, java.lang.String noteGuid, int updateSequenceNum, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Note recv_getNoteVersion() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Resource getResource(java.lang.String authenticationToken, java.lang.String guid, boolean withData, boolean withRecognition, boolean withAttributes, boolean withAlternateData) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResource
in interface NoteStoreIface
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 attributeswithAlternateData
- If true, the Resource will include the binary contents of the
'alternateData' field's body, if an alternate form is present.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getResource(java.lang.String authenticationToken, java.lang.String guid, boolean withData, boolean withRecognition, boolean withAttributes, boolean withAlternateData) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Resource recv_getResource() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public LazyMap getResourceApplicationData(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResourceApplicationData
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_getResourceApplicationData(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public LazyMap recv_getResourceApplicationData() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public java.lang.String getResourceApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResourceApplicationDataEntry
in interface NoteStoreIface
EDAMNotFoundException
- EDAMUserException
EDAMSystemException
com.evernote.thrift.TException
public void send_getResourceApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.lang.String recv_getResourceApplicationDataEntry() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int setResourceApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key, java.lang.String value) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
setResourceApplicationDataEntry
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_setResourceApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key, java.lang.String value) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_setResourceApplicationDataEntry() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int unsetResourceApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
unsetResourceApplicationDataEntry
in interface NoteStoreIface
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public void send_unsetResourceApplicationDataEntry(java.lang.String authenticationToken, java.lang.String guid, java.lang.String key) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_unsetResourceApplicationDataEntry() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public int updateResource(java.lang.String authenticationToken, Resource resource) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
updateResource
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_updateResource(java.lang.String authenticationToken, Resource resource) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_updateResource() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public byte[] getResourceData(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResourceData
in interface NoteStoreIface
guid
- The GUID of the resource to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getResourceData(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public byte[] recv_getResourceData() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Resource getResourceByHash(java.lang.String authenticationToken, java.lang.String noteGuid, byte[] contentHash, boolean withData, boolean withRecognition, boolean withAlternateData) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResourceByHash
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_getResourceByHash(java.lang.String authenticationToken, java.lang.String noteGuid, byte[] contentHash, boolean withData, boolean withRecognition, boolean withAlternateData) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Resource recv_getResourceByHash() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public byte[] getResourceRecognition(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResourceRecognition
in interface NoteStoreIface
guid
- The GUID of the resource whose recognition data should be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getResourceRecognition(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public byte[] recv_getResourceRecognition() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public byte[] getResourceAlternateData(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResourceAlternateData
in interface NoteStoreIface
guid
- The GUID of the resource whose recognition data should be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getResourceAlternateData(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public byte[] recv_getResourceAlternateData() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public ResourceAttributes getResourceAttributes(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
getResourceAttributes
in interface NoteStoreIface
guid
- The GUID of the resource whose attributes should be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getResourceAttributes(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public ResourceAttributes recv_getResourceAttributes() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public Notebook getPublicNotebook(int userId, java.lang.String publicUri) throws EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
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 https://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.
getPublicNotebook
in interface NoteStoreIface
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.getPublicUserInfopublicUri
- The uri string for the public notebook, from Notebook.publishing.uri.
EDAMSystemException
- EDAMNotFoundException
- com.evernote.thrift.TException
public void send_getPublicNotebook(int userId, java.lang.String publicUri) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public Notebook recv_getPublicNotebook() throws EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
public SharedNotebook createSharedNotebook(java.lang.String authenticationToken, SharedNotebook sharedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
createSharedNotebook
in interface NoteStoreIface
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.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_createSharedNotebook(java.lang.String authenticationToken, SharedNotebook sharedNotebook) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SharedNotebook recv_createSharedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public int updateSharedNotebook(java.lang.String authenticationToken, SharedNotebook sharedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
updateSharedNotebook
in interface NoteStoreIface
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
- The SharedNotebook object containing the requested changes.
The "id" of the shared notebook must be set to allow the service
to identify the SharedNotebook to be updated. In addition, you MUST set
the email, permission, and allowPreview fields to the desired values.
All other fields will be ignored if set.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_updateSharedNotebook(java.lang.String authenticationToken, SharedNotebook sharedNotebook) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_updateSharedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public int setSharedNotebookRecipientSettings(java.lang.String authenticationToken, long sharedNotebookId, SharedNotebookRecipientSettings recipientSettings) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
setSharedNotebookRecipientSettings
in interface NoteStoreIface
EDAMUserException
- EDAMNotFoundException
- "sharedNotebookId" - Thrown if the service does not
have a shared notebook record for the sharedNotebookId on the given shard. If you
receive this exception, it is probable that the shared notebook record has
been revoked or expired, or that you accessed the wrong shard.
EDAMSystemException
com.evernote.thrift.TException
public void send_setSharedNotebookRecipientSettings(java.lang.String authenticationToken, long sharedNotebookId, SharedNotebookRecipientSettings recipientSettings) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_setSharedNotebookRecipientSettings() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public int sendMessageToSharedNotebookMembers(java.lang.String authenticationToken, java.lang.String notebookGuid, java.lang.String messageText, java.util.List<java.lang.String> recipients) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
sendMessageToSharedNotebookMembers
in interface NoteStoreIface
authenticationToken
- The auth token of the user with permissions to share the notebooknotebookGuid
- The guid of the shared notebookmessageText
- User provided text to include in the emailrecipients
- The email addresses of the recipients. If this list is empty then all of the
users that the notebook has been shared with are emailed.
If an email address doesn't correspond to share invite members then that address
is ignored.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_sendMessageToSharedNotebookMembers(java.lang.String authenticationToken, java.lang.String notebookGuid, java.lang.String messageText, java.util.List<java.lang.String> recipients) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_sendMessageToSharedNotebookMembers() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public java.util.List<SharedNotebook> listSharedNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
listSharedNotebooks
in interface NoteStoreIface
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public void send_listSharedNotebooks(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.util.List<SharedNotebook> recv_listSharedNotebooks() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public int expungeSharedNotebooks(java.lang.String authenticationToken, java.util.List<java.lang.Long> sharedNotebookIds) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
expungeSharedNotebooks
in interface NoteStoreIface
sharedNotebookIds
- - a list of ShardNotebook.id longs identifying the
objects to delete permanently.
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public void send_expungeSharedNotebooks(java.lang.String authenticationToken, java.util.List<java.lang.Long> sharedNotebookIds) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_expungeSharedNotebooks() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public LinkedNotebook createLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
createLinkedNotebook
in interface NoteStoreIface
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
- EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public void send_createLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public LinkedNotebook recv_createLinkedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public int updateLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
updateLinkedNotebook
in interface NoteStoreIface
linkedNotebook
- Updates the name of a linked notebook.
EDAMUserException
- EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public void send_updateLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_updateLinkedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public java.util.List<LinkedNotebook> listLinkedNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
listLinkedNotebooks
in interface NoteStoreIface
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public void send_listLinkedNotebooks(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.util.List<LinkedNotebook> recv_listLinkedNotebooks() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public int expungeLinkedNotebook(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
expungeLinkedNotebook
in interface NoteStoreIface
guid
- The LinkedNotebook.guid field of the LinkedNotebook to permanently remove
from the account.
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public void send_expungeLinkedNotebook(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public int recv_expungeLinkedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public AuthenticationResult authenticateToSharedNotebook(java.lang.String shareKey, java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
authenticateToSharedNotebook
in interface NoteStoreIface
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.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
- com.evernote.thrift.TException
public void send_authenticateToSharedNotebook(java.lang.String shareKey, java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public AuthenticationResult recv_authenticateToSharedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public SharedNotebook getSharedNotebookByAuth(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
getSharedNotebookByAuth
in interface NoteStoreIface
authenticationToken
- Should be the authentication token retrieved from the reply of
authenticateToSharedNotebook(), proving access to a particular shared
notebook.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_getSharedNotebookByAuth(java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public SharedNotebook recv_getSharedNotebookByAuth() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public void emailNote(java.lang.String authenticationToken, NoteEmailParameters parameters) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
emailNote
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_emailNote(java.lang.String authenticationToken, NoteEmailParameters parameters) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public void recv_emailNote() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public java.lang.String shareNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
shareNote
in interface NoteStoreIface
guid
- The GUID of the note to be shared.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_shareNote(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public java.lang.String recv_shareNote() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public void stopSharingNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
stopSharingNote
in interface NoteStoreIface
guid
- The GUID of the note to be un-shared.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
com.evernote.thrift.TException
public void send_stopSharingNote(java.lang.String authenticationToken, java.lang.String guid) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public void recv_stopSharingNote() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public AuthenticationResult authenticateToSharedNote(java.lang.String guid, java.lang.String noteKey, java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
NoteStoreIface
authenticateToSharedNote
in interface NoteStoreIface
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
- com.evernote.thrift.TException
public void send_authenticateToSharedNote(java.lang.String guid, java.lang.String noteKey, java.lang.String authenticationToken) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public AuthenticationResult recv_authenticateToSharedNote() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, com.evernote.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
com.evernote.thrift.TException
public RelatedResult findRelated(java.lang.String authenticationToken, RelatedQuery query, RelatedResultSpec resultSpec) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
NoteStoreIface
findRelated
in interface NoteStoreIface
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
- EDAMSystemException
com.evernote.thrift.TException
public void send_findRelated(java.lang.String authenticationToken, RelatedQuery query, RelatedResultSpec resultSpec) throws com.evernote.thrift.TException
com.evernote.thrift.TException
public RelatedResult recv_findRelated() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, com.evernote.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
com.evernote.thrift.TException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |