|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NoteStoreIface
Service: NoteStore
The NoteStore service is used by EDAM clients to exchange information about the collection of notes in an account. This is primarily used for synchronization, but could also be used by a "thin" client without a full local cache.
All functions take an "authenticationToken" parameter, which is the value returned by the UserStore which permits access to the account. This parameter is mandatory for all functions.
Calls which require an authenticationToken may throw an EDAMUserException for the following reasons:
Method Summary | |
---|---|
AuthenticationResult |
authenticateToSharedNote(java.lang.String guid,
java.lang.String noteKey)
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 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. |
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)
Used to find a set of the notes from a user's account based on various criteria specified via a NoteFilter object. |
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. |
long |
getAccountSize(java.lang.String authenticationToken)
Deprecated. - This function is deprecated, and should no longer be used. This will always return a value of '0'. |
java.util.List<Ad> |
getAds(java.lang.String authenticationToken,
AdParameters adParameters)
Clients should make this call once per day to receive a bundle of ads that will be displayed for the subsequent 24 hour period. |
Notebook |
getDefaultNotebook(java.lang.String authenticationToken)
Returns the notebook that should be used to store new notes in the user's account when no other notebooks are specified. |
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. |
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. |
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. |
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. |
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)
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. |
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. |
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 |
updateTag(java.lang.String authenticationToken,
Tag tag)
Submits tag changes to the service. |
Method Detail |
---|
SyncState getSyncState(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMSystemException
TException
SyncChunk getSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, boolean fullSyncOnly) throws EDAMUserException, EDAMSystemException, TException
afterUSN
- The client can pass this value to ask only for objects that
have been updated after a certain point. This allows the client to
receive updates after its last checkpoint rather than doing a full
synchronization on every pass. The default value of "0" indicates
that the client wants to get objects from the start of the account.maxEntries
- The maximum number of modified objects that should be
returned in the result SyncChunk. This can be used to limit the size
of each individual message to be friendly for network transfer.fullSyncOnly
- If true, then the client only wants initial data for a full sync.
In this case, the service will not return any expunged objects,
and will not return any Resources, since these are also provided
in their corresponding Notes.authenticationToken
- afterUSN
- maxEntries
- fullSyncOnly
-
EDAMUserException
- EDAMSystemException
TException
SyncChunk getFilteredSyncChunk(java.lang.String authenticationToken, int afterUSN, int maxEntries, SyncChunkFilter filter) throws EDAMUserException, EDAMSystemException, TException
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.authenticationToken
- afterUSN
- maxEntries
- filter
-
EDAMUserException
- EDAMSystemException
TException
SyncState getLinkedNotebookSyncState(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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.authenticationToken
- linkedNotebook
-
EDAMUserException
EDAMSystemException
EDAMNotFoundException
TException
SyncChunk getLinkedNotebookSyncChunk(java.lang.String authenticationToken, LinkedNotebook linkedNotebook, int afterUSN, int maxEntries, boolean fullSyncOnly) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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.fullSyncOnly
- If true, then the client only wants initial data for a full sync.
In this case, the service will not return any expunged objects,
and will not return any Resources, since these are also provided
in their corresponding Notes.authenticationToken
- linkedNotebook
- afterUSN
- maxEntries
- fullSyncOnly
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.util.List<Notebook> listNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMSystemException
TException
Notebook getNotebook(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the notebook to be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
Notebook getDefaultNotebook(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMSystemException
TException
Notebook createNotebook(java.lang.String authenticationToken, Notebook notebook) throws EDAMUserException, EDAMSystemException, TException
notebook
- The desired fields for the notebook must be provided on this
object. The name of the notebook must be set, and either the 'active'
or 'defaultNotebook' fields may be set by the client at creation.
If a notebook exists in the account with the same name (via
case-insensitive compare), this will throw an EDAMUserException.authenticationToken
- notebook
-
EDAMUserException
- EDAMSystemException
TException
int updateNotebook(java.lang.String authenticationToken, Notebook notebook) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
notebook
- The notebook object containing the requested changes.authenticationToken
- notebook
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int expungeNotebook(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the notebook to delete.authenticationToken
- guid
-
EDAMUserException
- EDAMSystemException
EDAMNotFoundException
TException
java.util.List<Tag> listTags(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMSystemException
TException
java.util.List<Tag> listTagsByNotebook(java.lang.String authenticationToken, java.lang.String notebookGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
notebookGuid
- the GUID of the notebook to use to find tagsauthenticationToken
- notebookGuid
-
EDAMNotFoundException
- EDAMUserException
EDAMSystemException
TException
Tag getTag(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the tag to be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
Tag createTag(java.lang.String authenticationToken, Tag tag) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
tag
- The desired list of fields for the tag are specified in this
object. The caller must specify the tag name, and may provide
the parentGUID.authenticationToken
- tag
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int updateTag(java.lang.String authenticationToken, Tag tag) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
tag
- The tag object containing the requested changes.authenticationToken
- tag
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
void untagAll(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the tag to remove from all notes.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int expungeTag(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the tag to delete.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.util.List<SavedSearch> listSearches(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMSystemException
TException
SavedSearch getSearch(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the search to be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMSystemException
EDAMNotFoundException
TException
SavedSearch createSearch(java.lang.String authenticationToken, SavedSearch search) throws EDAMUserException, EDAMSystemException, TException
search
- The desired list of fields for the search are specified in this
object. The caller must specify the
name, query, and format of the search.authenticationToken
- search
-
EDAMUserException
- EDAMSystemException
TException
int updateSearch(java.lang.String authenticationToken, SavedSearch search) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
search
- The search object containing the requested changes.authenticationToken
- search
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int expungeSearch(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the search to delete.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
NoteList findNotes(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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 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.authenticationToken
- filter
- offset
- maxNotes
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int findNoteOffset(java.lang.String authenticationToken, NoteFilter filter, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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.authenticationToken
- filter
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
NotesMetadataList findNotesMetadata(java.lang.String authenticationToken, NoteFilter filter, int offset, int maxNotes, NotesMetadataResultSpec resultSpec) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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.authenticationToken
- filter
- offset
- maxNotes
- resultSpec
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
NoteCollectionCounts findNoteCounts(java.lang.String authenticationToken, NoteFilter filter, boolean withTrash) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
authenticationToken
- Must be a valid token for the user's account unless the NoteFilter
'notebookGuid' is the GUID of a public notebook.filter
- The note selection filter that is currently being applied. The note
counts are to be calculated with this filter applied to the total set
of notes in the user's account.withTrash
- If true, then the NoteCollectionCounts.trashCount will be calculated
and supplied in the reply. Otherwise, the trash value will be omitted.authenticationToken
- filter
- withTrash
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
Note getNote(java.lang.String authenticationToken, java.lang.String guid, boolean withContent, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the note to be retrieved.withContent
- If true, the note will include the ENML contents of its
'content' field.withResourcesData
- If true, any Resource elements in this Note will include the binary
contents of their 'data' field's body.withResourcesRecognition
- If true, any Resource elements will include the binary contents of the
'recognition' field's body if recognition data is present.withResourcesAlternateData
- If true, any Resource elements in this Note will include the binary
contents of their 'alternateData' fields' body, if an alternate form
is present.authenticationToken
- guid
- withContent
- withResourcesData
- withResourcesRecognition
- withResourcesAlternateData
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.lang.String getNoteContent(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the note to be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.lang.String getNoteSearchText(java.lang.String authenticationToken, java.lang.String guid, boolean noteOnly, boolean tokenizeForIndexing) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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.authenticationToken
- guid
- noteOnly
- tokenizeForIndexing
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.lang.String getResourceSearchText(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the resource to be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.util.List<java.lang.String> getNoteTagNames(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
Note createNote(java.lang.String authenticationToken, Note note) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
note
- A Note object containing the desired fields to be populated on
the service.authenticationToken
- note
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
Note updateNote(java.lang.String authenticationToken, Note note) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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.authenticationToken
- note
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int deleteNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the note to delete.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int expungeNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the note to delete.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int expungeNotes(java.lang.String authenticationToken, java.util.List<java.lang.String> noteGuids) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
noteGuids
- The list of GUIDs for the Notes to remove.authenticationToken
- noteGuids
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int expungeInactiveNotes(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMSystemException
TException
Note copyNote(java.lang.String authenticationToken, java.lang.String noteGuid, java.lang.String toNotebookGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
noteGuid
- The GUID of the Note to copy.toNotebookGuid
- The GUID of the Notebook that should receive the new Note.authenticationToken
- noteGuid
- toNotebookGuid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.util.List<NoteVersionId> listNoteVersions(java.lang.String authenticationToken, java.lang.String noteGuid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
authenticationToken
- noteGuid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
Note getNoteVersion(java.lang.String authenticationToken, java.lang.String noteGuid, int updateSequenceNum, boolean withResourcesData, boolean withResourcesRecognition, boolean withResourcesAlternateData) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- 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.authenticationToken
- noteGuid
- updateSequenceNum
- withResourcesData
- withResourcesRecognition
- withResourcesAlternateData
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
Resource getResource(java.lang.String authenticationToken, java.lang.String guid, boolean withData, boolean withRecognition, boolean withAttributes, boolean withAlternateData) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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.authenticationToken
- guid
- withData
- withRecognition
- withAttributes
- withAlternateData
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
int updateResource(java.lang.String authenticationToken, Resource resource) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
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:
authenticationToken
- resource
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
byte[] getResourceData(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the resource to be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
Resource getResourceByHash(java.lang.String authenticationToken, java.lang.String noteGuid, byte[] contentHash, boolean withData, boolean withRecognition, boolean withAlternateData) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
noteGuid
- The GUID of the note that holds the resource to be retrieved.contentHash
- The MD5 checksum of the resource within that note.withData
- If true, the Resource will include the binary contents of the
'data' field's body.withRecognition
- If true, the Resource will include the binary contents of the
'recognition' field's body.withAlternateData
- If true, the Resource will include the binary contents of the
'alternateData' field's body, if an alternate form is present.authenticationToken
- noteGuid
- contentHash
- withData
- withRecognition
- withAlternateData
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
byte[] getResourceRecognition(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the resource whose recognition data should be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
byte[] getResourceAlternateData(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the resource whose recognition data should be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
ResourceAttributes getResourceAttributes(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMSystemException, EDAMNotFoundException, TException
guid
- The GUID of the resource whose attributes should be retrieved.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
long getAccountSize(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMSystemException
TException
java.util.List<Ad> getAds(java.lang.String authenticationToken, AdParameters adParameters) throws EDAMUserException, EDAMSystemException, TException
adParameters
- A set of parameters that help the service determine which ads to return.authenticationToken
- adParameters
-
EDAMUserException
EDAMSystemException
TException
Ad getRandomAd(java.lang.String authenticationToken, AdParameters adParameters) throws EDAMUserException, EDAMSystemException, TException
adParameters
- A set of parameters to help the service determine which ad to return.
The 'impression' field should either be absent (if no ads have been
displayed previously), or else it should contain the identifier for
the most recently-displayed ad so that the service can give a different
ad.authenticationToken
- adParameters
-
EDAMUserException
EDAMSystemException
TException
Notebook getPublicNotebook(int userId, java.lang.String publicUri) throws EDAMSystemException, EDAMNotFoundException, TException
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.
If a notebook is visible on the web with a full URL like
http://www.evernote.com/pub/ensupport/faq
Then 'ensupport' is the username and 'faq' is the uri.userId
- publicUri
-
EDAMNotFoundException
- EDAMSystemException
TException
SharedNotebook createSharedNotebook(java.lang.String authenticationToken, SharedNotebook sharedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
sharedNotebook
- An shared notebook object populated with the email address of the share
recipient, the notebook guid and the access permissions. All other
attributes of the shared object are ignored.authenticationToken
- sharedNotebook
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.util.List<SharedNotebook> listSharedNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMNotFoundException
EDAMSystemException
TException
int expungeSharedNotebooks(java.lang.String authenticationToken, java.util.List<java.lang.Long> sharedNotebookIds) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
sharedNotebookIds
- - a list of ShardNotebook.id longs identifying the
objects to delete permanently.authenticationToken
- sharedNotebookIds
-
EDAMUserException
EDAMNotFoundException
EDAMSystemException
TException
LinkedNotebook createLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
linkedNotebook
- The desired fields for the linked notebook must be provided on this
object. The name of the linked notebook must be set. Either a username
uri or a shard id and share key must be provided otherwise a
EDAMUserException is thrown.authenticationToken
- linkedNotebook
-
EDAMUserException
- EDAMNotFoundException
EDAMSystemException
TException
int updateLinkedNotebook(java.lang.String authenticationToken, LinkedNotebook linkedNotebook) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
linkedNotebook
- Updates the name of a linked notebook.authenticationToken
- linkedNotebook
-
EDAMUserException
- EDAMNotFoundException
EDAMSystemException
TException
java.util.List<LinkedNotebook> listLinkedNotebooks(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
authenticationToken
-
EDAMUserException
EDAMNotFoundException
EDAMSystemException
TException
int expungeLinkedNotebook(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
guid
- The LinkedNotebook.guid field of the LinkedNotebook to permanently remove
from the account.authenticationToken
- guid
-
EDAMUserException
EDAMNotFoundException
EDAMSystemException
TException
AuthenticationResult authenticateToSharedNotebook(java.lang.String shareKey, java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
shareKey
- The 'shareKey' identifier from the SharedNotebook that was granted to
some recipient. This string internally encodes the notebook identifier
and a security signature.authenticationToken
- If a non-empty string is provided, this is the full user-based
authentication token that identifies the user who is currently logged in
and trying to access the shared notebook. This may be required if the
notebook was created with 'requireLogin'.
If this string is empty, the service will attempt to authenticate to the
shared notebook without any logged in user.shareKey
- authenticationToken
-
EDAMSystemException
- EDAMNotFoundException
- EDAMUserException
- TException
SharedNotebook getSharedNotebookByAuth(java.lang.String authenticationToken) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
authenticationToken
- Should be the authentication token retrieved from the reply of
authenticateToSharedNotebook(), proving access to a particular shared
notebook.authenticationToken
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
void emailNote(java.lang.String authenticationToken, NoteEmailParameters parameters) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
authenticationToken
- The note will be sent as the user logged in via this token, using that
user's registered email address. If the authenticated user doesn't
have permission to read that note, the emailing will fail.parameters
- The note must be specified either by GUID (in which case it will be
sent using the existing data in the service), or else the full Note
must be passed to this call. This also specifies the additional
email fields that will be used in the email.authenticationToken
- parameters
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
java.lang.String shareNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
guid
- The GUID of the note to be shared.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
void stopSharingNote(java.lang.String authenticationToken, java.lang.String guid) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
guid
- The GUID of the note to be un-shared.authenticationToken
- guid
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
AuthenticationResult authenticateToSharedNote(java.lang.String guid, java.lang.String noteKey) throws EDAMUserException, EDAMNotFoundException, EDAMSystemException, TException
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.guid
- noteKey
-
EDAMUserException
- EDAMNotFoundException
- EDAMSystemException
TException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |