|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.evernote.edam.notestore.NoteStore.Client
public static class NoteStore.Client
Field Summary | |
---|---|
protected org.apache.thrift.protocol.TProtocol |
iprot_
|
protected org.apache.thrift.protocol.TProtocol |
oprot_
|
protected int |
seqid_
|
Constructor Summary | |
---|---|
NoteStore.Client(org.apache.thrift.protocol.TProtocol prot)
|
|
NoteStore.Client(org.apache.thrift.protocol.TProtocol iprot,
org.apache.thrift.protocol.TProtocol oprot)
|
Method Summary | |
---|---|
AuthenticationResult |
authenticateToSharedNotebook(java.lang.String shareKey,
java.lang.String authenticationToken)
Asks the service to produce an authentication token that can be used to access the contents of a shared notebook from someone else's account. |
Note |
copyNote(java.lang.String authenticationToken,
java.lang.String noteGuid,
java.lang.String toNotebookGuid)
Performs a deep copy of the Note with the provided GUID 'noteGuid' into the Notebook with the provided GUID 'toNotebookGuid'. |
LinkedNotebook |
createLinkedNotebook(java.lang.String authenticationToken,
LinkedNotebook linkedNotebook)
Asks the service to make a linked notebook with the provided name, username of the owner and identifiers provided. |
Note |
createNote(java.lang.String authenticationToken,
Note note)
Asks the service to make a note with the provided set of information. |
Notebook |
createNotebook(java.lang.String authenticationToken,
Notebook notebook)
Asks the service to make a notebook with the provided name. |
SavedSearch |
createSearch(java.lang.String authenticationToken,
SavedSearch search)
Asks the service to make a saved search with a set of information. |
SharedNotebook |
createSharedNotebook(java.lang.String authenticationToken,
SharedNotebook sharedNotebook)
Used to construct a shared notebook object. |
Tag |
createTag(java.lang.String authenticationToken,
Tag tag)
Asks the service to make a tag with a set of information. |
int |
deleteNote(java.lang.String authenticationToken,
java.lang.String guid)
Moves the note into the trash. |
void |
emailNote(java.lang.String authenticationToken,
NoteEmailParameters parameters)
Attempts to send a single note to one or more email recipients. |
int |
expungeInactiveNotes(java.lang.String authenticationToken)
Permanently removes all of the Notes that are currently marked as inactive. |
int |
expungeLinkedNotebook(java.lang.String authenticationToken,
long linkedNotebookId)
Permanently expunges the linked notebook from the account. |
int |
expungeNote(java.lang.String authenticationToken,
java.lang.String guid)
Permanently removes the Note, and all of its Resources, from the service. |
int |
expungeNotebook(java.lang.String authenticationToken,
java.lang.String guid)
Permanently removes the notebook from the user's account. |
int |
expungeNotes(java.lang.String authenticationToken,
java.util.List<java.lang.String> noteGuids)
Permanently removes a list of Notes, and all of their Resources, from the service. |
int |
expungeSearch(java.lang.String authenticationToken,
java.lang.String guid)
Permanently deletes the search with the provided GUID, if present. |
int |
expungeSharedNotebooks(java.lang.String authenticationToken,
java.util.List<java.lang.Long> sharedNotebookIds)
Expunges the SharedNotebooks in the user's account using the SharedNotebook.id as the identifier. |
int |
expungeTag(java.lang.String authenticationToken,
java.lang.String guid)
Permanently deletes the tag with the provided GUID, if present. |
NoteCollectionCounts |
findNoteCounts(java.lang.String authenticationToken,
NoteFilter filter,
boolean withTrash)
This function is used to determine how many notes are found for each notebook and tag in the user's account, given a current set of filter parameters that determine the current selection. |
NoteList |
findNotes(java.lang.String authenticationToken,
NoteFilter filter,
int offset,
int maxNotes)
Used to find a set of the notes from a user's account based on various criteria specified via a NoteFilter object. |
long |
getAccountSize(java.lang.String authenticationToken)
|
java.util.List<Ad> |
getAds(java.lang.String authenticationToken,
AdParameters adParameters)
Clients should make this call once per day to receive a bundle of ads that will be displayed for the subsequent 24 hour period. |
Notebook |
getDefaultNotebook(java.lang.String authenticationToken)
Returns the notebook that should be used to store new notes in the user's account when no other notebooks are specified. |
org.apache.thrift.protocol.TProtocol |
getInputProtocol()
|
Note |
getNote(java.lang.String authenticationToken,
java.lang.String guid,
boolean withContent,
boolean withResourcesData,
boolean withResourcesRecognition,
boolean withResourcesAlternateData)
Returns the current state of the note in the service with the provided GUID. |
Notebook |
getNotebook(java.lang.String authenticationToken,
java.lang.String guid)
Returns the current state of the notebook with the provided GUID. |
java.lang.String |
getNoteContent(java.lang.String authenticationToken,
java.lang.String guid)
Returns XHTML contents of the note with the provided GUID. |
java.lang.String |
getNoteSearchText(java.lang.String authenticationToken,
java.lang.String guid)
Returns a block of the extracted plain text contents of the note with the provided GUID. |
java.util.List<java.lang.String> |
getNoteTagNames(java.lang.String authenticationToken,
java.lang.String guid)
Returns a list of the names of the tags for the note with the provided guid. |
Note |
getNoteVersion(java.lang.String authenticationToken,
java.lang.String noteGuid,
int updateSequenceNum,
boolean withResourcesData,
boolean withResourcesRecognition,
boolean withResourcesAlternateData)
This can be used to retrieve a previous version of a Note after it has been updated within the service. |
org.apache.thrift.protocol.TProtocol |
getOutputProtocol()
|
Notebook |
getPublicNotebook(int userId,
java.lang.String publicUri)
Looks for a user account with the provided userId on this NoteStore shard and determines whether that account contains a public notebook with the given URI. |
Ad |
getRandomAd(java.lang.String authenticationToken,
AdParameters adParameters)
A thin client should make this call to retrieve a single random ad for immediate display. |
Resource |
getResource(java.lang.String authenticationToken,
java.lang.String guid,
boolean withData,
boolean withRecognition,
boolean withAttributes,
boolean withAlternateData)
Returns the current state of the resource in the service with the provided GUID. |
byte[] |
getResourceAlternateData(java.lang.String authenticationToken,
java.lang.String guid)
If the Resource with the provided GUID has an alternate data representation (indicated via the Resource.alternateData field), then this request can be used to retrieve the binary contents of that alternate data file. |
ResourceAttributes |
getResourceAttributes(java.lang.String authenticationToken,
java.lang.String guid)
Returns the set of attributes for the Resource with the provided GUID. |
Resource |
getResourceByHash(java.lang.String authenticationToken,
java.lang.String noteGuid,
byte[] contentHash,
boolean withData,
boolean withRecognition,
boolean withAlternateData)
Returns the current state of a resource, referenced by containing note GUID and resource content hash. |
byte[] |
getResourceData(java.lang.String authenticationToken,
java.lang.String guid)
Returns binary data of the resource with the provided GUID. |
byte[] |
getResourceRecognition(java.lang.String authenticationToken,
java.lang.String guid)
Returns the binary contents of the recognition index for the resource with the provided GUID. |
SavedSearch |
getSearch(java.lang.String authenticationToken,
java.lang.String guid)
Returns the current state of the search with the provided GUID. |
SharedNotebook |
getSharedNotebookByAuth(java.lang.String authenticationToken)
This function is used to retrieve extended information about a shared notebook by a guest who has already authenticated to access that notebook. |
SyncChunk |
getSyncChunk(java.lang.String authenticationToken,
int afterUSN,
int maxEntries,
boolean fullSyncOnly)
Asks the NoteStore to provide the state of the account in order of last modification. |
SyncState |
getSyncState(java.lang.String authenticationToken)
Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token. |
Tag |
getTag(java.lang.String authenticationToken,
java.lang.String guid)
Returns the current state of the Tag with the provided GUID. |
java.util.List<LinkedNotebook> |
listLinkedNotebooks(java.lang.String authenticationToken)
Returns a list of linked notebooks |
java.util.List<Notebook> |
listNotebooks(java.lang.String authenticationToken)
Returns a list of all of the notebooks in the account. |
java.util.List<NoteVersionId> |
listNoteVersions(java.lang.String authenticationToken,
java.lang.String noteGuid)
Returns a list of the prior versions of a particular note that are saved within the service. |
java.util.List<SavedSearch> |
listSearches(java.lang.String authenticationToken)
Returns a list of the searches in the account. |
java.util.List<SharedNotebook> |
listSharedNotebooks(java.lang.String authenticationToken)
Lists the collection of shared notebooks for all notebooks in the users account. |
java.util.List<Tag> |
listTags(java.lang.String authenticationToken)
Returns a list of the tags in the account. |
java.util.List<Tag> |
listTagsByNotebook(java.lang.String authenticationToken,
java.lang.String notebookGuid)
Returns a list of the tags that are applied to at least one note within the provided notebook. |
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()
|
NoteList |
recv_findNotes()
|
long |
recv_getAccountSize()
|
java.util.List<Ad> |
recv_getAds()
|
Notebook |
recv_getDefaultNotebook()
|
Note |
recv_getNote()
|
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()
|
Ad |
recv_getRandomAd()
|
Resource |
recv_getResource()
|
byte[] |
recv_getResourceAlternateData()
|
ResourceAttributes |
recv_getResourceAttributes()
|
Resource |
recv_getResourceByHash()
|
byte[] |
recv_getResourceData()
|
byte[] |
recv_getResourceRecognition()
|
SavedSearch |
recv_getSearch()
|
SharedNotebook |
recv_getSharedNotebookByAuth()
|
SyncChunk |
recv_getSyncChunk()
|
SyncState |
recv_getSyncState()
|
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()
|
void |
recv_untagAll()
|
LinkedNotebook |
recv_updateLinkedNotebook()
|
Note |
recv_updateNote()
|
int |
recv_updateNotebook()
|
int |
recv_updateResource()
|
int |
recv_updateSearch()
|
int |
recv_updateTag()
|
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,
long linkedNotebookId)
|
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_findNotes(java.lang.String authenticationToken,
NoteFilter filter,
int offset,
int maxNotes)
|
void |
send_getAccountSize(java.lang.String authenticationToken)
|
void |
send_getAds(java.lang.String authenticationToken,
AdParameters adParameters)
|
void |
send_getDefaultNotebook(java.lang.String authenticationToken)
|
void |
send_getNote(java.lang.String authenticationToken,
java.lang.String guid,
boolean withContent,
boolean withResourcesData,
boolean withResourcesRecognition,
boolean withResourcesAlternateData)
|
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)
|
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_getRandomAd(java.lang.String authenticationToken,
AdParameters adParameters)
|
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_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_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_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_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_updateTag(java.lang.String authenticationToken,
Tag tag)
|
void |
untagAll(java.lang.String authenticationToken,
java.lang.String guid)
Removes the provided tag from every note that is currently tagged with this tag. |
LinkedNotebook |
updateLinkedNotebook(java.lang.String authenticationToken,
LinkedNotebook linkedNotebook)
|
Note |
updateNote(java.lang.String authenticationToken,
Note note)
Submit a set of changes to a note to the service. |
int |
updateNotebook(java.lang.String authenticationToken,
Notebook notebook)
Submits notebook changes to the service. |
int |
updateResource(java.lang.String authenticationToken,
Resource resource)
Submit a set of changes to a resource to the service. |
int |
updateSearch(java.lang.String authenticationToken,
SavedSearch search)
Submits search changes to the service. |
int |
updateTag(java.lang.String authenticationToken,
Tag tag)
Submits tag changes to the service. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.apache.thrift.protocol.TProtocol iprot_
protected org.apache.thrift.protocol.TProtocol oprot_
protected int seqid_
Constructor Detail |
---|
public NoteStore.Client(org.apache.thrift.protocol.TProtocol prot)
public NoteStore.Client(org.apache.thrift.protocol.TProtocol iprot, org.apache.thrift.protocol.TProtocol oprot)
Method Detail |
---|
public org.apache.thrift.protocol.TProtocol getInputProtocol()
public org.apache.thrift.protocol.TProtocol getOutputProtocol()
public SyncState getSyncState(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
getSyncState
in interface NoteStore.Iface
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_getSyncState(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public SyncState recv_getSyncState() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public SyncChunk getSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, boolean fullSyncOnly) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
getSyncChunk
in interface NoteStore.Iface
afterUSN
- The client can pass this value to ask only for objects that
have been updated after a certain point. This allows the client to
receive updates after its last checkpoint rather than doing a full
synchronization on every pass. The default value of "0" indicates
that the client wants to get objects from the start of the account.maxEntries
- The maximum number of modified objects that should be
returned in the result SyncChunk. This can be used to limit the size
of each individual message to be friendly for network transfer.fullSyncOnly
- If true, then the client only wants initial data for a full sync.
In this case, the service will not return any expunged objects,
and will not return any Resources, since these are also provided
in their corresponding Notes.
EDAMUserException
- EDAMSystemException
org.apache.thrift.TException
public void send_getSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, boolean fullSyncOnly) throws org.apache.thrift.TException
org.apache.thrift.TException
public SyncChunk recv_getSyncChunk() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public java.util.List<Notebook> listNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
listNotebooks
in interface NoteStore.Iface
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_listNotebooks(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<Notebook> recv_listNotebooks() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public Notebook getNotebook(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getNotebook
in interface NoteStore.Iface
guid
- The GUID of the notebook to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getNotebook(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public Notebook recv_getNotebook() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public Notebook getDefaultNotebook(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
getDefaultNotebook
in interface NoteStore.Iface
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_getDefaultNotebook(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public Notebook recv_getDefaultNotebook() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public Notebook createNotebook(java.lang.String authenticationToken, Notebook notebook) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
createNotebook
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_createNotebook(java.lang.String authenticationToken, Notebook notebook) throws org.apache.thrift.TException
org.apache.thrift.TException
public Notebook recv_createNotebook() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public int updateNotebook(java.lang.String authenticationToken, Notebook notebook) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
updateNotebook
in interface NoteStore.Iface
notebook
- The notebook object containing the requested changes.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_updateNotebook(java.lang.String authenticationToken, Notebook notebook) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_updateNotebook() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int expungeNotebook(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
expungeNotebook
in interface NoteStore.Iface
guid
- The GUID of the notebook to delete.
EDAMUserException
- EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public void send_expungeNotebook(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_expungeNotebook() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public java.util.List<Tag> listTags(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
listTags
in interface NoteStore.Iface
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_listTags(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<Tag> recv_listTags() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public java.util.List<Tag> listTagsByNotebook(java.lang.String authenticationToken, java.lang.String notebookGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
listTagsByNotebook
in interface NoteStore.Iface
notebookGuid
- the GUID of the notebook to use to find tags
EDAMNotFoundException
- EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_listTagsByNotebook(java.lang.String authenticationToken, java.lang.String notebookGuid) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<Tag> recv_listTagsByNotebook() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public Tag getTag(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getTag
in interface NoteStore.Iface
guid
- The GUID of the tag to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getTag(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public Tag recv_getTag() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public Tag createTag(java.lang.String authenticationToken, Tag tag) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
createTag
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_createTag(java.lang.String authenticationToken, Tag tag) throws org.apache.thrift.TException
org.apache.thrift.TException
public Tag recv_createTag() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int updateTag(java.lang.String authenticationToken, Tag tag) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
updateTag
in interface NoteStore.Iface
tag
- The tag object containing the requested changes.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_updateTag(java.lang.String authenticationToken, Tag tag) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_updateTag() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public void untagAll(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
untagAll
in interface NoteStore.Iface
guid
- The GUID of the tag to remove from all notes.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_untagAll(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public void recv_untagAll() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int expungeTag(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
expungeTag
in interface NoteStore.Iface
guid
- The GUID of the tag to delete.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_expungeTag(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_expungeTag() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public java.util.List<SavedSearch> listSearches(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
listSearches
in interface NoteStore.Iface
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_listSearches(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<SavedSearch> recv_listSearches() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public SavedSearch getSearch(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getSearch
in interface NoteStore.Iface
guid
- The GUID of the search to be retrieved.
EDAMUserException
- EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public void send_getSearch(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public SavedSearch recv_getSearch() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public SavedSearch createSearch(java.lang.String authenticationToken, SavedSearch search) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
createSearch
in interface NoteStore.Iface
search
- The desired list of fields for the search are specified in this
object. The caller must specify the
name, query, and format of the search.
EDAMUserException
- EDAMSystemException
org.apache.thrift.TException
public void send_createSearch(java.lang.String authenticationToken, SavedSearch search) throws org.apache.thrift.TException
org.apache.thrift.TException
public SavedSearch recv_createSearch() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public int updateSearch(java.lang.String authenticationToken, SavedSearch search) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
updateSearch
in interface NoteStore.Iface
search
- The search object containing the requested changes.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_updateSearch(java.lang.String authenticationToken, SavedSearch search) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_updateSearch() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int expungeSearch(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
expungeSearch
in interface NoteStore.Iface
guid
- The GUID of the search to delete.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_expungeSearch(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_expungeSearch() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public NoteList findNotes(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
findNotes
in interface NoteStore.Iface
authenticationToken
- Must be a valid token for the user's account unless the NoteFilter
'notebookGuid' is the GUID of a public notebook.filter
- The list of criteria that will constrain the notes to be returned.offset
- The numeric index of the first note to show within the sorted
results. The numbering scheme starts with "0". This can be used for
pagination.maxNotes
- The most notes to return in this query. The service will
either return this many notes or the end of the notebook, whichever is
shorter.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_findNotes(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes) throws org.apache.thrift.TException
org.apache.thrift.TException
public NoteList recv_findNotes() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public NoteCollectionCounts findNoteCounts(java.lang.String authenticationToken, NoteFilter filter, boolean withTrash) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
findNoteCounts
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_findNoteCounts(java.lang.String authenticationToken, NoteFilter filter, boolean withTrash) throws org.apache.thrift.TException
org.apache.thrift.TException
public NoteCollectionCounts recv_findNoteCounts() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.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, org.apache.thrift.TException
NoteStore.Iface
getNote
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_getNote(java.lang.String authenticationToken, java.lang.String guid, boolean withContent, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) throws org.apache.thrift.TException
org.apache.thrift.TException
public Note recv_getNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public java.lang.String getNoteContent(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getNoteContent
in interface NoteStore.Iface
guid
- The GUID of the note to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getNoteContent(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.lang.String recv_getNoteContent() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public java.lang.String getNoteSearchText(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getNoteSearchText
in interface NoteStore.Iface
guid
- The GUID of the note to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getNoteSearchText(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.lang.String recv_getNoteSearchText() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public java.util.List<java.lang.String> getNoteTagNames(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getNoteTagNames
in interface NoteStore.Iface
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getNoteTagNames(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<java.lang.String> recv_getNoteTagNames() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public Note createNote(java.lang.String authenticationToken, Note note) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
createNote
in interface NoteStore.Iface
note
- A Note object containing the desired fields to be populated on
the service.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_createNote(java.lang.String authenticationToken, Note note) throws org.apache.thrift.TException
org.apache.thrift.TException
public Note recv_createNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public Note updateNote(java.lang.String authenticationToken, Note note) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
updateNote
in interface NoteStore.Iface
note
- A Note object containing the desired fields to be populated on
the service.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_updateNote(java.lang.String authenticationToken, Note note) throws org.apache.thrift.TException
org.apache.thrift.TException
public Note recv_updateNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int deleteNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
deleteNote
in interface NoteStore.Iface
guid
- The GUID of the note to delete.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_deleteNote(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_deleteNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int expungeNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
expungeNote
in interface NoteStore.Iface
guid
- The GUID of the note to delete.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_expungeNote(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_expungeNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int expungeNotes(java.lang.String authenticationToken, java.util.List<java.lang.String> noteGuids) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
expungeNotes
in interface NoteStore.Iface
noteGuids
- The list of GUIDs for the Notes to remove.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_expungeNotes(java.lang.String authenticationToken, java.util.List<java.lang.String> noteGuids) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_expungeNotes() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int expungeInactiveNotes(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
expungeInactiveNotes
in interface NoteStore.Iface
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_expungeInactiveNotes(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_expungeInactiveNotes() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public Note copyNote(java.lang.String authenticationToken, java.lang.String noteGuid, java.lang.String toNotebookGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
copyNote
in interface NoteStore.Iface
noteGuid
- The GUID of the Note to copy.toNotebookGuid
- The GUID of the Notebook that should receive the new Note.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_copyNote(java.lang.String authenticationToken, java.lang.String noteGuid, java.lang.String toNotebookGuid) throws org.apache.thrift.TException
org.apache.thrift.TException
public Note recv_copyNote() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public java.util.List<NoteVersionId> listNoteVersions(java.lang.String authenticationToken, java.lang.String noteGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
listNoteVersions
in interface NoteStore.Iface
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_listNoteVersions(java.lang.String authenticationToken, java.lang.String noteGuid) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<NoteVersionId> recv_listNoteVersions() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.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, org.apache.thrift.TException
NoteStore.Iface
getNoteVersion
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_getNoteVersion(java.lang.String authenticationToken, java.lang.String noteGuid, int updateSequenceNum, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) throws org.apache.thrift.TException
org.apache.thrift.TException
public Note recv_getNoteVersion() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.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, org.apache.thrift.TException
NoteStore.Iface
getResource
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_getResource(java.lang.String authenticationToken, java.lang.String guid, boolean withData, boolean withRecognition, boolean withAttributes, boolean withAlternateData) throws org.apache.thrift.TException
org.apache.thrift.TException
public Resource recv_getResource() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public int updateResource(java.lang.String authenticationToken, Resource resource) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
updateResource
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_updateResource(java.lang.String authenticationToken, Resource resource) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_updateResource() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public byte[] getResourceData(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getResourceData
in interface NoteStore.Iface
guid
- The GUID of the resource to be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getResourceData(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public byte[] recv_getResourceData() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.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, org.apache.thrift.TException
NoteStore.Iface
getResourceByHash
in interface NoteStore.Iface
noteGuid
- The GUID of the note that holds the resource to be retrieved.contentHash
- The MD5 checksum of the resource within that note.withData
- If true, the Resource will include the binary contents of the
'data' field's body.withRecognition
- If true, the Resource will include the binary contents of the
'recognition' field's body.withAlternateData
- If true, the Resource will include the binary contents of the
'alternateData' field's body, if an alternate form is present.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getResourceByHash(java.lang.String authenticationToken, java.lang.String noteGuid, byte[] contentHash, boolean withData, boolean withRecognition, boolean withAlternateData) throws org.apache.thrift.TException
org.apache.thrift.TException
public Resource recv_getResourceByHash() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public byte[] getResourceRecognition(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getResourceRecognition
in interface NoteStore.Iface
guid
- The GUID of the resource whose recognition data should be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getResourceRecognition(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public byte[] recv_getResourceRecognition() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public byte[] getResourceAlternateData(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getResourceAlternateData
in interface NoteStore.Iface
guid
- The GUID of the resource whose recognition data should be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getResourceAlternateData(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public byte[] recv_getResourceAlternateData() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public ResourceAttributes getResourceAttributes(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getResourceAttributes
in interface NoteStore.Iface
guid
- The GUID of the resource whose attributes should be retrieved.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getResourceAttributes(java.lang.String authenticationToken, java.lang.String guid) throws org.apache.thrift.TException
org.apache.thrift.TException
public ResourceAttributes recv_getResourceAttributes() throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public long getAccountSize(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
getAccountSize
in interface NoteStore.Iface
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_getAccountSize(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public long recv_getAccountSize() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public java.util.List<Ad> getAds(java.lang.String authenticationToken, AdParameters adParameters) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
getAds
in interface NoteStore.Iface
adParameters
- A set of parameters that help the service determine which ads to return.
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_getAds(java.lang.String authenticationToken, AdParameters adParameters) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<Ad> recv_getAds() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public Ad getRandomAd(java.lang.String authenticationToken, AdParameters adParameters) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
getRandomAd
in interface NoteStore.Iface
adParameters
- A set of parameters to help the service determine which ad to return.
The 'impression' field should either be absent (if no ads have been
displayed previously), or else it should contain the identifier for
the most recently-displayed ad so that the service can give a different
ad.
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_getRandomAd(java.lang.String authenticationToken, AdParameters adParameters) throws org.apache.thrift.TException
org.apache.thrift.TException
public Ad recv_getRandomAd() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public Notebook getPublicNotebook(int userId, java.lang.String publicUri) throws EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
NoteStore.Iface
getPublicNotebook
in interface NoteStore.Iface
EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getPublicNotebook(int userId, java.lang.String publicUri) throws org.apache.thrift.TException
org.apache.thrift.TException
public Notebook recv_getPublicNotebook() throws EDAMSystemException, EDAMNotFoundException, org.apache.thrift.TException
EDAMSystemException
EDAMNotFoundException
org.apache.thrift.TException
public SharedNotebook createSharedNotebook(java.lang.String authenticationToken, SharedNotebook sharedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
createSharedNotebook
in interface NoteStore.Iface
sharedNotebook
- An shared notebook object populated with the email address of the share
recipient, the notebook guid and the access permissions. All other
attributes of the shared object are ignored.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_createSharedNotebook(java.lang.String authenticationToken, SharedNotebook sharedNotebook) throws org.apache.thrift.TException
org.apache.thrift.TException
public SharedNotebook recv_createSharedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public java.util.List<SharedNotebook> listSharedNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
listSharedNotebooks
in interface NoteStore.Iface
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public void send_listSharedNotebooks(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<SharedNotebook> recv_listSharedNotebooks() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public int expungeSharedNotebooks(java.lang.String authenticationToken, java.util.List<java.lang.Long> sharedNotebookIds) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
expungeSharedNotebooks
in interface NoteStore.Iface
sharedNotebookIds
- - a list of ShardNotebook.id longs identifying the
objects to delete permanently.
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public void send_expungeSharedNotebooks(java.lang.String authenticationToken, java.util.List<java.lang.Long> sharedNotebookIds) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_expungeSharedNotebooks() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public LinkedNotebook createLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
createLinkedNotebook
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_createLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws org.apache.thrift.TException
org.apache.thrift.TException
public LinkedNotebook recv_createLinkedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public LinkedNotebook updateLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
updateLinkedNotebook
in interface NoteStore.Iface
linkedNotebook
- Updates the name of a linked notebook.
EDAMUserException
- EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public void send_updateLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws org.apache.thrift.TException
org.apache.thrift.TException
public LinkedNotebook recv_updateLinkedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public java.util.List<LinkedNotebook> listLinkedNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
listLinkedNotebooks
in interface NoteStore.Iface
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public void send_listLinkedNotebooks(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public java.util.List<LinkedNotebook> recv_listLinkedNotebooks() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public int expungeLinkedNotebook(java.lang.String authenticationToken, long linkedNotebookId) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
expungeLinkedNotebook
in interface NoteStore.Iface
linkedNotebookId
- The LinkedNotebook.id field of the LinkedNotebook to permanently remove
from the account.
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public void send_expungeLinkedNotebook(java.lang.String authenticationToken, long linkedNotebookId) throws org.apache.thrift.TException
org.apache.thrift.TException
public int recv_expungeLinkedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public AuthenticationResult authenticateToSharedNotebook(java.lang.String shareKey, java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
authenticateToSharedNotebook
in interface NoteStore.Iface
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
- org.apache.thrift.TException
public void send_authenticateToSharedNotebook(java.lang.String shareKey, java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public AuthenticationResult recv_authenticateToSharedNotebook() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public SharedNotebook getSharedNotebookByAuth(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
getSharedNotebookByAuth
in interface NoteStore.Iface
authenticationToken
- Should be the authentication token retrieved from the reply of
authenticateToSharedNotebook(), proving access to a particular shared
notebook.
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
org.apache.thrift.TException
public void send_getSharedNotebookByAuth(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public SharedNotebook recv_getSharedNotebookByAuth() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public void emailNote(java.lang.String authenticationToken, NoteEmailParameters parameters) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
NoteStore.Iface
emailNote
in interface NoteStore.Iface
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
org.apache.thrift.TException
public void send_emailNote(java.lang.String authenticationToken, NoteEmailParameters parameters) throws org.apache.thrift.TException
org.apache.thrift.TException
public void recv_emailNote() throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |