EvernoteNoteStore Class Reference
| Inherits from | ENAPI |
| Declared in |
EvernoteNoteStore.h EvernoteNoteStore.m |
Overview
Asynchronous functions for all the note store api’s.
This class is a wrapper over all the Note store api’s that provides asynchronism and abstraction.
It also provides easy access to business api’s.
Some utility functions for the Evernote NoteStore, which makes it easier to use Business API’s and Shared Note API’s.
Tasks
Creating a NoteStore
-
+ noteStoreGet an instance, using the shared EvernoteSession.
-
+ businessNoteStoreGet an instance of the business note store, using the shared EvernoteSession.
-
– currentNoteStoreGet an instance of the current note store client.
-
+ noteStoreForLinkedNotebook:Get an instance of a notestore for a linked notebook. This can be used for shared notebooks.
-
– initWithSession:Construct an instance with the given session.
NoteStore sync methods
-
– getSyncStateWithSuccess:failure:Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token.
-
– getSyncChunkAfterUSN:maxEntries:fullSyncOnly:success:failure:Asks the NoteStore to provide the state of the account in order of last modification.
-
– getFilteredSyncChunkAfterUSN:maxEntries:filter:success:failure:Asks the NoteStore to provide the state of the account in order of last modification.
-
– getLinkedNotebookSyncState:success:failure: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.
-
– getLinkedNotebookSyncChunk:afterUSN:maxEntries:fullSyncOnly:success:failure: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.
NoteStore notebook methods
-
– listNotebooksWithSuccess:failure:Returns a list of all of the notebooks in the account.
-
– getNotebookWithGuid:success:failure:Returns the current state of the notebook with the provided GUID. The notebook may be active or deleted (but not expunged).
-
– getDefaultNotebookWithSuccess:failure:Returns the notebook that should be used to store new notes in the user’s account when no other notebooks are specified.
-
– createNotebook:success:failure:Asks the service to make a notebook with the provided name.
-
– updateNotebook:success:failure:Submits notebook changes to the service. The provided data must include the notebook’s guid field for identification.
-
– expungeNotebookWithGuid:success:failure:Permanently removes the notebook from the user’s account. After this action, the notebook is no longer available for undeletion, etc. If the notebook contains any Notes, they will be moved to the current default notebook and moved into the trash (i.e. Note.active=false).
NoteStore tag methods
-
– listTagsWithSuccess:failure:Returns a list of the tags in the account. Evernote does not support the undeletion of tags, so this will only include active tags.
-
– listTagsByNotebookWithGuid:success:failure:Returns a list of the tags that are applied to at least one note within the provided notebook. If the notebook is public, the authenticationToken may be ignored.
-
– getTagWithGuid:success:failure:Asks the service to make a tag with a set of information.
-
– createTag:success:failure:Asks the service to make a tag with a set of information.
-
– updateTag:success:failure:Submits tag changes to the service. The provided data must include the tag’s guid field for identification. The service will apply updates to the following tag fields: name, parentGuid
-
– untagAllWithGuid:success:failure:Removes the provided tag from every note that is currently tagged with this tag. If this operation is successful, the tag will still be in the account, but it will not be tagged on any notes.
-
– expungeTagWithGuid:success:failure:Permanently deletes the tag with the provided GUID, if present.
NoteStore SavedSearch methods
-
– listSearchesWithSuccess:failure:Returns a list of the searches in the account. Evernote does not support the undeletion of searches, so this will only include active searches.
-
– getSearchWithGuid:success:failure:Returns the current state of the search with the provided GUID.
-
– createSearch:success:failure:Asks the service to make a saved search with a set of information.
-
– updateSearch:success:failure:Submits search changes to the service. The provided data must include the search’s guid field for identification. The service will apply updates to the following search fields: name, query, and format.
-
– expungeSearchWithGuid:success:failure:Permanently deletes the saved search with the provided GUID, if present.
NoteStore notes methods
-
– findRealtedWithQuery:resultSpec:success:failure:Identify related entities on the service, such as notes, notebooks, and tags related to notes or content.
-
– findNotesWithFilter:offset:maxNotes:success:failure:Used to find a set of the notes from a user’s account based on various criteria specified via a NoteFilter object.
-
– findNoteOffsetWithFilter:guid:success:failure:Finds the position of a note within a sorted subset of all of the user’s notes.
-
– findNotesMetadataWithFilter:offset:maxNotes:resultSpec:success:failure: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.
-
– findNoteCountsWithFilter:withTrash:success:failure: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.
-
– getNoteWithGuid:withContent:withResourcesData:withResourcesRecognition:withResourcesAlternateData:success:failure:Returns the current state of the note in the service with the provided GUID. The ENML contents of the note will only be provided if the ‘withContent’ parameter is true.
-
– getNoteApplicationDataWithGuid:success:failure:Get all of the application data for the note identified by GUID, with values returned within the LazyMap fullMap field.
-
– getNoteApplicationDataEntryWithGuid:key:success:failure:Get the value of a single entry in the applicationData map for the note identified by GUID.
-
– setNoteApplicationDataEntryWithGuid:key:value:success:failure:Update, or create, an entry in the applicationData map for the note identified by guid.
-
– unsetNoteApplicationDataEntryWithGuid:key:success:failure:Remove an entry identified by ‘key’ from the applicationData map for the note identified by ‘guid’. Silently ignores an unset of a non-existing key.
-
– getNoteContentWithGuid:success:failure:Returns XHTML contents of the note with the provided GUID. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
-
– getNoteSearchTextWithGuid:noteOnly:tokenizeForIndexing:success:failure:Returns a block of the extracted plain text contents of the note with the provided GUID.
-
– getResourceSearchTextWithGuid:success:failure:Returns a block of the extracted plain text contents of the resource with the provided GUID.
-
– getNoteTagNamesWithGuid:success:failure:Returns a list of the names of the tags for the note with the provided guid.
-
– createNote:success:failure:Asks the service to make a note with the provided set of information.
-
– updateNote:success:failure:Submit a set of changes to a note to the service.
-
– deleteNoteWithGuid:success:failure:Moves the note into the trash. The note may still be undeleted, unless it is expunged.
-
– expungeNoteWithGuid:success:failure:Permanently removes a Note, and all of its Resources, from the service.
-
– expungeNotesWithGuids:success:failure:Permanently removes a list of Notes, and all of their Resources, from the service.
-
– expungeInactiveNoteWithSuccess:failure:Permanently removes all of the Notes that are currently marked as inactive.
-
– copyNoteWithGuid:toNoteBookGuid:success:failure:Performs a deep copy of the Note with the provided GUID ‘noteGuid’ into the Notebook with the provided GUID ‘toNotebookGuid’.
-
– listNoteVersionsWithGuid:success:failure:Returns a list of the prior versions of a particular note that are saved within the service.
-
– getNoteVersionWithGuid:updateSequenceNum:withResourcesData:withResourcesRecognition:withResourcesAlternateData:success:failure:This can be used to retrieve a previous version of a Note after it has been updated within the service.
NoteStore resource methods
-
– getResourceWithGuid:withData:withRecognition:withAttributes:withAlternateDate:success:failure:Returns the current state of the resource in the service with the provided GUID.
-
– getResourceApplicationDataWithGuid:success:failure:Get all of the application data for the Resource identified by GUID, with values returned within the LazyMap fullMap field. If there are no applicationData entries, then a LazyMap with an empty fullMap will be returned. If your application only needs to fetch its own applicationData entry, use getResourceApplicationDataEntry instead.
-
– getResourceApplicationDataEntryWithGuid:key:success:failure:Get the value of a single entry in the applicationData map for the Resource identified by GUID.
-
– setResourceApplicationDataEntryWithGuid:key:value:success:failure:Update, or create, an entry in the applicationData map for the Resource identified by guid.
-
– unsetResourceApplicationDataEntryWithGuid:key:success:failure:Remove an entry identified by ‘key’ from the applicationData map for the Resource identified by ‘guid’.
-
– updateResource:success:failure:Submit a set of changes to a resource to the service.
-
– getResourceDataWithGuid:success:failure:Returns binary data of the resource with the provided GUID.
-
– getResourceByHashWithGuid:contentHash:withData:withRecognition:withAlternateData:success:failure:Returns the current state of a resource, referenced by containing note GUID and resource content hash.
-
– getResourceRecognitionWithGuid:success:failure:Returns the binary contents of the recognition index for the resource with the provided GUID.
-
– getResourceAlternateDataWithGuid:success:failure:If the Resource with the provided GUID has an alternate data representation (indicated via the Resource.alternateData field), then this request can be used to retrieve the binary contents of that alternate data file. If the caller asks about a resource that has no alternate data form, this will throw EDAMNotFoundException.
-
– getResourceAttributesWithGuid:success:failure:Returns the set of attributes for the Resource with the provided GUID. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
NoteStore shared notebook methods
-
– getPublicNotebookWithUserID:publicUri:success:failure: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.
-
– createSharedNotebook:success:failure:Used to construct a shared notebook object. The constructed notebook will contain a “share key” which serve as a unique identifer and access token for a user to access the notebook of the shared notebook owner.
-
– sendMessageToSharedNotebookMembersWithGuid:messageText:recipients:success:failure:Send a reminder message to some or all of the email addresses that a notebook has been shared with.
-
– listSharedNotebooksWithSuccess:failure:Lists the collection of shared notebooks for all notebooks in the users account.
-
– expungeSharedNotebooksWithIds:success:failure:Expunges the SharedNotebooks in the user’s account using the SharedNotebook.id as the identifier.
-
– createLinkedNotebook:success:failure:Asks the service to make a linked notebook with the provided name, username of the owner and identifiers provided.
-
– updateLinkedNotebook:success:failure:Asks the service to update a linked notebook.
-
– listLinkedNotebooksWithSuccess:failure:Returns a list of linked notebooks
-
– expungeLinkedNotebookWithGuid:success:failure:Permanently expunges the linked notebook from the account.
-
– authenticateToSharedNotebookWithShareKey:success:failure: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.
-
– getSharedNotebookByAuthWithSuccess:failure:This function is used to retrieve extended information about a shared notebook by a guest who has already authenticated to access that notebook.
-
– emailNoteWithParameters:success:failure:Attempts to send a single note to one or more email recipients.
-
– shareNoteWithGuid:success:failure:If this note is not already shared (via its own direct URL), then this will start sharing that note.
-
– stopSharingNoteWithGuid:success:failure: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. If the Note is not shared, then this function will do nothing.
-
– authenticateToSharedNoteWithGuid:noteKey:success:failure: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.
-
– updateSharedNotebook:success:failure:Update a SharedNotebook object.
Extras Methods
-
– listNotesForLinkedNotebook:withFilter:success:failure:Asks the NoteStore to all the notes in the given linked notebook.
-
– listBusinessNotebooksWithSuccess:failure:List all the business notebooks in a users account.
-
– isBusinessNotebookWritable:success:failure:Check if the business notebook is writable.
-
– createBusinessNotebook:success:failure:Create a new business notebook.
-
– deleteBusinessNotebook:success:failure:Remove a business notebook from a users account.
-
– getCorrespondingNotebookForBusinessNotebook:success:failure:Get the corresponding Notebook, given a Linked Notebook
-
– createBusinessNote:success:failure:Create a new business note (has be in an existing business notebook)
-
– createBusinessTag:success:failure:Create a new business tag
-
– saveNewNoteToEvernoteApp:withType:Save a new note to the Evernote for iOS app
-
– viewNoteInEvernote:View a note using the Evernote for iOS app
-
– cancelCancel the first operation in the queue
Class Methods
businessNoteStore
Get an instance of the business note store, using the shared EvernoteSession.
+ (instancetype)businessNoteStore
Discussion
Get an instance of the business note store, using the shared EvernoteSession.
Declared In
EvernoteNoteStore.hnoteStore
Get an instance, using the shared EvernoteSession.
+ (instancetype)noteStore
Discussion
Get an instance, using the shared EvernoteSession.
Declared In
EvernoteNoteStore.hnoteStoreForLinkedNotebook:
Get an instance of a notestore for a linked notebook. This can be used for shared notebooks.
+
(instancetype)noteStoreForLinkedNotebook:(EDAMLinkedNotebook
*)notebook
Parameters
- notebook
The linked notebook
Discussion
Get an instance of a notestore for a linked notebook. This can be used for shared notebooks.
Declared In
EvernoteNoteStore.hInstance Methods
authenticateToSharedNoteWithGuid:noteKey:success:failure:
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.
- (void)authenticateToSharedNoteWithGuid:(NSString *)guid
noteKey:(NSString *)noteKey success:(void ( ^ ) (
EDAMAuthenticationResult *result ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- 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.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the service to produce an authentication token that can be used to access the contents of a single Note which was individually shared from someone’s account.
This authenticationToken can be used with the various other NoteStore calls to find and retrieve the Note and its directly-referenced children.
Declared In
EvernoteNoteStore.hauthenticateToSharedNotebookWithShareKey:success:failure:
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.
- (void)authenticateToSharedNotebookWithShareKey:(NSString
*)shareKey success:(void ( ^ ) (
EDAMAuthenticationResult *result ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- shareKey
-
The ‘shareKey’ identifier from the SharedNotebook that was granted to some recipient. This string internally encodes the notebook identifier and a security signature.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the service to produce an authentication token that can be used to access the contents of a shared notebook from someone else’s account.
This authenticationToken can be used with the various other NoteStore calls to find and retrieve notes, and if the permissions in the shared notebook are sufficient, to make changes to the contents of the notebook.
Declared In
EvernoteNoteStore.hcancel
Cancel the first operation in the queue
- (void)cancel
Discussion
Cancel the first operation in the queue
Declared In
EvernoteNoteStore+Extras.hcopyNoteWithGuid:toNoteBookGuid:success:failure:
Performs a deep copy of the Note with the provided GUID ‘noteGuid’ into the Notebook with the provided GUID ‘toNotebookGuid’.
- (void)copyNoteWithGuid:(EDAMGuid)guid
toNoteBookGuid:(EDAMGuid)toNotebookGuid success:(void
( ^ ) ( EDAMNote *note ))success failure:(void ( ^ )
( NSError *error ))failure
Parameters
- guid
The GUID of the Note to copy.
- toNotebookGuid
-
The GUID of the Notebook that should receive the new Note.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Performs a deep copy of the Note with the provided GUID ‘noteGuid’ into the Notebook with the provided GUID ‘toNotebookGuid’.
The caller must be the owner of both the Note and the Notebook. This creates a new Note in the destination Notebook with new content and Resources that match all of the content and Resources from the original Note, but with new GUID identifiers. The original Note is not modified by this operation. The copied note is considered as an “upload” for the purpose of upload transfer limit calculation, so its size is added to the upload count for the owner.
Declared In
EvernoteNoteStore.hcreateBusinessNote:success:failure:
Create a new business note (has be in an existing business notebook)
- (void)createBusinessNote:(EDAMNote *)note
success:(void ( ^ ) ( EDAMNote *note ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- note
Details on the business note to be created.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Create a new business note (has be in an existing business notebook)
Declared In
EvernoteNoteStore+Extras.hcreateBusinessNotebook:success:failure:
Create a new business notebook.
- (void)createBusinessNotebook:(EDAMNotebook *)notebook
success:(void ( ^ ) ( EDAMLinkedNotebook *notebook ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- notebook
-
Details on the business notebook to be created.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Create a new business notebook.
This is a utility function that makes it easier to create a new Business notebook. Internally, it does the authentication to Business for you.
Declared In
EvernoteNoteStore+Extras.hcreateBusinessTag:success:failure:
Create a new business tag
- (void)createBusinessTag:(EDAMTag *)tag
success:(void ( ^ ) ( EDAMTag *tag ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- tag
Details on the business tag to be created.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Create a new business tag
Declared In
EvernoteNoteStore+Extras.hcreateLinkedNotebook:success:failure:
Asks the service to make a linked notebook with the provided name, username of the owner and identifiers provided.
- (void)createLinkedNotebook:(EDAMLinkedNotebook *)linkedNotebook
success:(void ( ^ ) ( EDAMLinkedNotebook *linkedNotebook ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- linkedNotebook
-
The desired fields for the linked notebook must be provided on this object. The name of the linked notebook must be set. Either a username uri or a shard id and share key must be provided otherwise a EDAMUserException is thrown.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the service to make a linked notebook with the provided name, username of the owner and identifiers provided.
A linked notebook can be either a link to a public notebook or to a private shared notebook.
Declared In
EvernoteNoteStore.hcreateNote:success:failure:
Asks the service to make a note with the provided set of information.
- (void)createNote:(EDAMNote *)note success:(void (
^ ) ( EDAMNote *note ))success failure:(void ( ^ ) (
NSError *error ))failure
Parameters
- note
-
A Note object containing the desired fields to be populated on the service.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the service to make a note with the provided set of information.
Exceptions
- EDAMUserException
Thrown if the note is not valid.
- EDAMNotFoundException
If the note is not found by GUID
Declared In
EvernoteNoteStore.hcreateNotebook:success:failure:
Asks the service to make a notebook with the provided name.
- (void)createNotebook:(EDAMNotebook *)notebook
success:(void ( ^ ) ( EDAMNotebook *notebook ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- notebook
-
The desired fields for the notebook must be provided on this object. The name of the notebook must be set, and either the ‘active’ or ‘defaultNotebook’ fields may be set by the client at creation. If a notebook exists in the account with the same name (via case-insensitive compare), this will throw an EDAMUserException.
- success
-
Success completion block with the newly created Notebook. The server-side GUID will be saved in this object’s ‘guid’ field.
- failure
Failure completion block.
Discussion
Asks the service to make a notebook with the provided name.
Declared In
EvernoteNoteStore.hcreateSearch:success:failure:
Asks the service to make a saved search with a set of information.
- (void)createSearch:(EDAMSavedSearch *)search
success:(void ( ^ ) ( EDAMSavedSearch *search ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- search
-
The desired list of fields for the search are specified in this object. The caller must specify the name, query, and format of the search.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the service to make a saved search with a set of information.
Declared In
EvernoteNoteStore.hcreateSharedNotebook:success:failure:
Used to construct a shared notebook object. The constructed notebook will contain a “share key” which serve as a unique identifer and access token for a user to access the notebook of the shared notebook owner.
- (void)createSharedNotebook:(EDAMSharedNotebook *)sharedNotebook
success:(void ( ^ ) ( EDAMSharedNotebook *sharedNotebook ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- sharedNotebook
-
An shared notebook object populated with the email address of the share recipient, the notebook guid and the access permissions. All other attributes of the shared object are ignored.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Used to construct a shared notebook object. The constructed notebook will contain a “share key” which serve as a unique identifer and access token for a user to access the notebook of the shared notebook owner.
Declared In
EvernoteNoteStore.hcreateTag:success:failure:
Asks the service to make a tag with a set of information.
- (void)createTag:(EDAMTag *)tag success:(void ( ^ )
( EDAMTag *tag ))success failure:(void ( ^ ) (
NSError *error ))failure
Parameters
- tag
-
The desired list of fields for the tag are specified in this object. The caller must specify the tag name, and may provide the parentGUID.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the service to make a tag with a set of information.
Declared In
EvernoteNoteStore.hcurrentNoteStore
Get an instance of the current note store client.
- (EDAMNoteStoreClient *)currentNoteStore
Discussion
Get an instance of the current note store client.
Declared In
EvernoteNoteStore.hdeleteBusinessNotebook:success:failure:
Remove a business notebook from a users account.
- (void)deleteBusinessNotebook:(EDAMLinkedNotebook *)notebook
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- notebook
-
Details on the business notebook to be removed.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Remove a business notebook from a users account.
This is a utility function that makes it easier to create a new Business notebook. Internally, it does the authentication to Business for you.
Declared In
EvernoteNoteStore+Extras.hdeleteNoteWithGuid:success:failure:
Moves the note into the trash. The note may still be undeleted, unless it is expunged.
- (void)deleteNoteWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note to delete.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Moves the note into the trash. The note may still be undeleted, unless it is expunged.
This is equivalent to calling updateNote() after setting Note.active = false
Declared In
EvernoteNoteStore.hemailNoteWithParameters:success:failure:
Attempts to send a single note to one or more email recipients.
- (void)emailNoteWithParameters:(EDAMNoteEmailParameters
*)parameters success:(void ( ^ ) ( ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- 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.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Attempts to send a single note to one or more email recipients.
Declared In
EvernoteNoteStore.hexpungeInactiveNoteWithSuccess:failure:
Permanently removes all of the Notes that are currently marked as inactive.
- (void)expungeInactiveNoteWithSuccess:(void ( ^ ) ( int32_t
usn ))success failure:(void ( ^ ) ( NSError *error
))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
Permanently removes all of the Notes that are currently marked as inactive.
This is equivalent to “emptying the trash”, and these Notes will be gone permanently. This operation may be relatively slow if the account contains a large number of inactive Notes.
NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
Declared In
EvernoteNoteStore.hexpungeLinkedNotebookWithGuid:success:failure:
Permanently expunges the linked notebook from the account.
- (void)expungeLinkedNotebookWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
-
The LinkedNotebook.guid field of the LinkedNotebook to permanently remove from the account.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Permanently expunges the linked notebook from the account.
NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
Declared In
EvernoteNoteStore.hexpungeNoteWithGuid:success:failure:
Permanently removes a Note, and all of its Resources, from the service.
- (void)expungeNoteWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note to delete.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Permanently removes a Note, and all of its Resources, from the service.
NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
Declared In
EvernoteNoteStore.hexpungeNotebookWithGuid:success:failure:
Permanently removes the notebook from the user’s account. After this action, the notebook is no longer available for undeletion, etc. If the notebook contains any Notes, they will be moved to the current default notebook and moved into the trash (i.e. Note.active=false).
- (void)expungeNotebookWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the notebook to delete.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Permanently removes the notebook from the user’s account. After this action, the notebook is no longer available for undeletion, etc. If the notebook contains any Notes, they will be moved to the current default notebook and moved into the trash (i.e. Note.active=false).
Declared In
EvernoteNoteStore.hexpungeNotesWithGuids:success:failure:
Permanently removes a list of Notes, and all of their Resources, from the service.
- (void)expungeNotesWithGuids:(NSMutableArray *)guids
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guids
The list of GUIDs for the Notes to remove.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Permanently removes a list of Notes, and all of their Resources, from the service.
This should be invoked with a small number of Note GUIDs (e.g. 100 or less) on each call. To expunge a larger number of notes, call this method multiple times. This should also be used to reduce the number of Notes in a notebook before calling expungeNotebook() or in the trash before calling expungeInactiveNotes(), since these calls may be prohibitively slow if there are more than a few hundred notes. If an exception is thrown for any of the GUIDs, then none of the notes will be deleted. I.e. this call can be treated as an atomic transaction.
NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
Declared In
EvernoteNoteStore.hexpungeSearchWithGuid:success:failure:
Permanently deletes the saved search with the provided GUID, if present.
- (void)expungeSearchWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the search to delete.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Permanently deletes the saved search with the provided GUID, if present.
NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
Declared In
EvernoteNoteStore.hexpungeSharedNotebooksWithIds:success:failure:
Expunges the SharedNotebooks in the user’s account using the SharedNotebook.id as the identifier.
- (void)expungeSharedNotebooksWithIds:(NSMutableArray *)sharedNotebookIds
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- sharedNotebookIds
-
a list of ShardNotebook.id longs identifying the objects to delete permanently.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Expunges the SharedNotebooks in the user’s account using the SharedNotebook.id as the identifier.
NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
Declared In
EvernoteNoteStore.hexpungeTagWithGuid:success:failure:
Permanently deletes the tag with the provided GUID, if present.
- (void)expungeTagWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the tag to delete.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Permanently deletes the tag with the provided GUID, if present.
NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
Declared In
EvernoteNoteStore.hfindNoteCountsWithFilter:withTrash:success:failure:
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.
- (void)findNoteCountsWithFilter:(EDAMNoteFilter *)filter
withTrash:(BOOL)withTrash success:(void ( ^ ) (
EDAMNoteCollectionCounts *counts ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- 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.
- success
Success completion block.
- failure
Failure completion block.
Discussion
This function is used to determine how many notes are found for each notebook and tag in the user’s account, given a current set of filter parameters that determine the current selection.
This function will return a structure that gives the note count for each notebook and tag that has at least one note under the requested filter. Any notebook or tag that has zero notes in the filtered set will not be listed in the reply to this function (so they can be assumed to be 0).
Declared In
EvernoteNoteStore.hfindNoteOffsetWithFilter:guid:success:failure:
Finds the position of a note within a sorted subset of all of the user’s notes.
- (void)findNoteOffsetWithFilter:(EDAMNoteFilter *)filter
guid:(EDAMGuid)guid success:(void ( ^ ) ( int32_t
offset ))success failure:(void ( ^ ) ( NSError *error
))failure
Parameters
- filter
-
The list of criteria that will constrain the notes to be returned.
- guid
The GUID of the note to be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Finds the position of a note within a sorted subset of all of the user’s notes.
This may be useful for thin clients that are displaying a paginated listing of a large account, which need to know where a particular note sits in the list without retrieving all notes first.
Declared In
EvernoteNoteStore.hfindNotesMetadataWithFilter:offset:maxNotes:resultSpec:success:failure:
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.
- (void)findNotesMetadataWithFilter:(EDAMNoteFilter *)filter
offset:(int32_t)offset maxNotes:(int32_t)maxNotes
resultSpec:(EDAMNotesMetadataResultSpec *)resultSpec
success:(void ( ^ ) ( EDAMNotesMetadataList *metadata ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- 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.
- success
Success completion block.
- failure
Failure completion block.
Discussion
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.
This should be used instead of ‘findNotes’ whenever the client doesn’t really need all of the deep structure of every Note and Resource, but just wants a high-level list of information. This will save time and bandwidth.
Declared In
EvernoteNoteStore.hfindNotesWithFilter:offset:maxNotes:success:failure:
Used to find a set of the notes from a user’s account based on various criteria specified via a NoteFilter object.
- (void)findNotesWithFilter:(EDAMNoteFilter *)filter
offset:(int32_t)offset maxNotes:(int32_t)maxNotes
success:(void ( ^ ) ( EDAMNoteList *list ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- 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.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Used to find a set of the notes from a user’s account based on various criteria specified via a NoteFilter object.
The Notes (and any embedded Resources) will have empty Data bodies for contents, resource data, and resource recognition fields. These values must be retrieved individually.
Declared In
EvernoteNoteStore.hfindRealtedWithQuery:resultSpec:success:failure:
Identify related entities on the service, such as notes, notebooks, and tags related to notes or content.
- (void)findRealtedWithQuery:(EDAMRelatedQuery *)query
resultSpec:(EDAMRelatedResultSpec *)resultSpec
success:(void ( ^ ) ( EDAMRelatedResult *result ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- query
-
The information about which we are finding related entities.
- resultSpec
-
Allows the client to indicate the type and quantity of information to be returned, allowing a saving of time and bandwidth.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Identify related entities on the service, such as notes, notebooks, and tags related to notes or content.
Declared In
EvernoteNoteStore.hgetCorrespondingNotebookForBusinessNotebook:success:failure:
Get the corresponding Notebook, given a Linked Notebook
-
(void)getCorrespondingNotebookForBusinessNotebook:(EDAMLinkedNotebook
*)notebook success:(void ( ^ ) ( EDAMNotebook
*notebook ))success failure:(void ( ^ ) ( NSError
*error ))failure
Parameters
- notebook
-
Details on the linked notebook, for which you need a notebook.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Get the corresponding Notebook, given a Linked Notebook
Declared In
EvernoteNoteStore+Extras.hgetDefaultNotebookWithSuccess:failure:
Returns the notebook that should be used to store new notes in the user’s account when no other notebooks are specified.
- (void)getDefaultNotebookWithSuccess:(void ( ^ ) (
EDAMNotebook *notebook ))success failure:(void ( ^ )
( NSError *error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns the notebook that should be used to store new notes in the user’s account when no other notebooks are specified.
Declared In
EvernoteNoteStore.hgetFilteredSyncChunkAfterUSN:maxEntries:filter:success:failure:
Asks the NoteStore to provide the state of the account in order of last modification.
- (void)getFilteredSyncChunkAfterUSN:(int32_t)afterUSN
maxEntries:(int32_t)maxEntries
filter:(EDAMSyncChunkFilter *)filter success:(void (
^ ) ( EDAMSyncChunk *syncChunk ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- afterUSN
-
The client can pass this value to ask only for objects that have been updated after a certain point. This allows the client to receive updates after its last checkpoint rather than doing a full synchronization on every pass. The default value of “0” indicates that the client wants to get objects from the start of the account.
- maxEntries
-
The maximum number of modified objects that should be returned in the result SyncChunk. This can be used to limit the size of each individual message to be friendly for network transfer.
- 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.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the NoteStore to provide the state of the account in order of last modification.
This request retrieves one block of the server’s state so that a client can make several small requests against a large account rather than getting the entire state in one big message. This call gives more fine-grained control of the data that will be received by a client by omitting data elements that a client doesn’t need. This may reduce network traffic and sync times.
Declared In
EvernoteNoteStore.hgetLinkedNotebookSyncChunk:afterUSN:maxEntries:fullSyncOnly:success:failure:
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.
- (void)getLinkedNotebookSyncChunk:(EDAMLinkedNotebook *)linkedNotebook
afterUSN:(int32_t)afterUSN maxEntries:(int32_t)maxEntries
fullSyncOnly:(BOOL)fullSyncOnly success:(void ( ^ ) (
EDAMSyncChunk *syncChunk ))success failure:(void ( ^
) ( NSError *error ))failure
Parameters
- linkedNotebook
-
This structure should contain identifying information and permissions to access the notebook in question. This must contain the valid fields for either a shared notebook (e.g. shareKey) or a public notebook (e.g. username, uri)
- afterUSN
-
The client can pass this value to ask only for objects that have been updated after a certain point. This allows the client to receive updates after its last checkpoint rather than doing a full synchronization on every pass. The default value of “0” indicates that the client wants to get objects from the start of the account.
- maxEntries
-
The maximum number of modified objects that should be returned in the result SyncChunk. This can be used to limit the size of each individual message to be friendly for network transfer. Applications should not request more than 256 objects at a time, and must handle the case where the service returns less than the requested number of objects in a given request even though more objects are available on the service.
- fullSyncOnly
-
If true, then the client only wants initial data for a full sync. In this case, the service will not return any expunged objects, and will not return any Resources, since these are also provided in their corresponding Notes.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the NoteStore to provide information about the contents of a linked notebook that has been shared with the caller, or that is public to the world.
This will return a result that is similar to getSyncChunk, but will only contain entries that are visible to the caller. I.e. only that particular Notebook will be visible, along with its Notes, and Tags on those Notes. This function must be called on the shard that owns the referenced notebook. (I.e. the shardId in /shard/shardId/edam/note must be the same as LinkedNotebook.shardId.)
Declared In
EvernoteNoteStore.hgetLinkedNotebookSyncState:success:failure:
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.
- (void)getLinkedNotebookSyncState:(EDAMLinkedNotebook *)linkedNotebook
success:(void ( ^ ) ( EDAMSyncState *syncState ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- linkedNotebook
-
This structure should contain identifying information and permissions to access the notebook in question.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the NoteStore to provide information about the status of a linked notebook that has been shared with the caller, or that is public to the world.
This will return a result that is similar to getSyncState, but may omit SyncState.uploaded if the caller doesn’t have permission to write to the linked notebook. This function must be called on the shard that owns the referenced notebook. (I.e. the shardId in /shard/shardId/edam/note must be the same as LinkedNotebook.shardId.)
Declared In
EvernoteNoteStore.hgetNoteApplicationDataEntryWithGuid:key:success:failure:
Get the value of a single entry in the applicationData map for the note identified by GUID.
- (void)getNoteApplicationDataEntryWithGuid:(EDAMGuid)guid
key:(NSString *)key success:(void ( ^ ) ( NSString
*entry ))success failure:(void ( ^ ) ( NSError *error
))failure
Parameters
- guid
The GUID of the note
- key
The key in the dictionary
- success
Success completion block.
- failure
Failure completion block.
Discussion
Get the value of a single entry in the applicationData map for the note identified by GUID.
Declared In
EvernoteNoteStore.hgetNoteApplicationDataWithGuid:success:failure:
Get all of the application data for the note identified by GUID, with values returned within the LazyMap fullMap field.
- (void)getNoteApplicationDataWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( EDAMLazyMap *map ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
-
The GUID of the note who’s application data is to be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Get all of the application data for the note identified by GUID, with values returned within the LazyMap fullMap field.
If there are no applicationData entries, then a LazyMap with an empty fullMap will be returned. If your application only needs to fetch its own applicationData entry, use getNoteApplicationDataEntry instead.
Declared In
EvernoteNoteStore.hgetNoteContentWithGuid:success:failure:
Returns XHTML contents of the note with the provided GUID. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
- (void)getNoteContentWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSString *content ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note to be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns XHTML contents of the note with the provided GUID. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
Declared In
EvernoteNoteStore.hgetNoteSearchTextWithGuid:noteOnly:tokenizeForIndexing:success:failure:
Returns a block of the extracted plain text contents of the note with the provided GUID.
- (void)getNoteSearchTextWithGuid:(EDAMGuid)guid
noteOnly:(BOOL)noteOnly tokenizeForIndexing:(BOOL)tokenizeForIndexing
success:(void ( ^ ) ( NSString *text ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- 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. @param success Success completion block.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a block of the extracted plain text contents of the note with the provided GUID.
This text can be indexed for search purposes by a light client that doesn’t have capabilities to extract all of the searchable text content from the note and its resources. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
Declared In
EvernoteNoteStore.hgetNoteTagNamesWithGuid:success:failure:
Returns a list of the names of the tags for the note with the provided guid.
- (void)getNoteTagNamesWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSArray *names ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a list of the names of the tags for the note with the provided guid.
This can be used with authentication to get the tags for a user’s own note, or can be used without valid authentication to retrieve the names of the tags for a note in a public notebook.
Declared In
EvernoteNoteStore.hgetNoteVersionWithGuid:updateSequenceNum:withResourcesData:withResourcesRecognition:withResourcesAlternateData:success:failure:
This can be used to retrieve a previous version of a Note after it has been updated within the service.
- (void)getNoteVersionWithGuid:(EDAMGuid)guid
updateSequenceNum:(int32_t)updateSequenceNum
withResourcesData:(BOOL)withResourcesData
withResourcesRecognition:(BOOL)withResourcesRecognition
withResourcesAlternateData:(BOOL)withResourcesAlternateData
success:(void ( ^ ) ( EDAMNote *note ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note to be retrieved.
- updateSequenceNum
-
The USN of the version of the note that is being retrieved
- withResourcesData
-
If true, any Resource elements in this Note will include the binary contents of their ‘data’ field’s body.
- withResourcesRecognition
-
If true, any Resource elements will include the binary contents of the ‘recognition’ field’s body if recognition data is present.
- withResourcesAlternateData
-
If true, any Resource elements in this Note will include the binary contents of their ‘alternateData’ fields' body, if an alternate form is present.
- success
Success completion block.
- failure
Failure completion block.
Discussion
This can be used to retrieve a previous version of a Note after it has been updated within the service.
The caller must identify the note (via its guid) and the version (via the updateSequenceNumber of that version). to find a listing of the stored version USNs for a note, call listNoteVersions. This call is only available for notes in Premium accounts. (I.e. access to past versions of Notes is a Premium-only feature.)
Declared In
EvernoteNoteStore.hgetNoteWithGuid:withContent:withResourcesData:withResourcesRecognition:withResourcesAlternateData:success:failure:
Returns the current state of the note in the service with the provided GUID. The ENML contents of the note will only be provided if the ‘withContent’ parameter is true.
- (void)getNoteWithGuid:(EDAMGuid)guid
withContent:(BOOL)withContent
withResourcesData:(BOOL)withResourcesData
withResourcesRecognition:(BOOL)withResourcesRecognition
withResourcesAlternateData:(BOOL)withResourcesAlternateData
success:(void ( ^ ) ( EDAMNote *note ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note to be retrieved.
- withContent
-
If true, the note will include the ENML contents of its ‘content’ field.
- withResourcesData
-
If true, any Resource elements in this Note will include the binary contents of their ‘data’ field’s body.
- withResourcesRecognition
-
If true, any Resource elements will include the binary contents of the ‘recognition’ field’s body if recognition data is present.
- withResourcesAlternateData
-
If true, any Resource elements in this Note will include the binary contents of their ‘alternateData’ fields' body, if an alternate form is present.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns the current state of the note in the service with the provided GUID. The ENML contents of the note will only be provided if the ‘withContent’ parameter is true.
The service will include the meta-data for each resource in the note, but the binary contents of the resources and their recognition data will be omitted. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string). The applicationData fields are returned as keysOnly.
Declared In
EvernoteNoteStore.hgetNotebookWithGuid:success:failure:
Returns the current state of the notebook with the provided GUID. The notebook may be active or deleted (but not expunged).
- (void)getNotebookWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( EDAMNotebook *notebook ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the notebook to be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns the current state of the notebook with the provided GUID. The notebook may be active or deleted (but not expunged).
Declared In
EvernoteNoteStore.hgetPublicNotebookWithUserID:publicUri:success:failure:
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.
- (void)getPublicNotebookWithUserID:(EDAMUserID)userId
publicUri:(NSString *)publicUri success:(void ( ^ ) (
EDAMNotebook *notebook ))success failure:(void ( ^ )
( NSError *error ))failure
Parameters
- userId
-
The numeric identifier for the user who owns the public notebook. To find this value based on a username string, you can invoke UserStore.getPublicUserInfo
- publicUri
-
The uri string for the public notebook, from Notebook.publishing.uri.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Looks for a user account with the provided userId on this NoteStore shard and determines whether that account contains a public notebook with the given URI.
If the account is not found, or no public notebook exists with this URI, this will throw an EDAMNotFoundException, otherwise this will return the information for that Notebook. If a notebook is visible on the web with a full URL like https://www.evernote.com/pub/sethdemo/api Then ‘sethdemo’ is the username that can be used to look up the userId, and ‘api’ is the publicUri.
Declared In
EvernoteNoteStore.hgetResourceAlternateDataWithGuid:success:failure:
If the Resource with the provided GUID has an alternate data representation (indicated via the Resource.alternateData field), then this request can be used to retrieve the binary contents of that alternate data file. If the caller asks about a resource that has no alternate data form, this will throw EDAMNotFoundException.
- (void)getResourceAlternateDataWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSData *data ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
-
The GUID of the resource whose recognition data should be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
If the Resource with the provided GUID has an alternate data representation (indicated via the Resource.alternateData field), then this request can be used to retrieve the binary contents of that alternate data file. If the caller asks about a resource that has no alternate data form, this will throw EDAMNotFoundException.
Declared In
EvernoteNoteStore.hgetResourceApplicationDataEntryWithGuid:key:success:failure:
Get the value of a single entry in the applicationData map for the Resource identified by GUID.
- (void)getResourceApplicationDataEntryWithGuid:(EDAMGuid)guid
key:(NSString *)key success:(void ( ^ ) ( NSString
*entry ))success failure:(void ( ^ ) ( NSError *error
))failure
Parameters
- guid
The GUID of the Resource.
- key
key in the dictionary
- success
Success completion block.
- failure
Failure completion block.
Discussion
Get the value of a single entry in the applicationData map for the Resource identified by GUID.
Declared In
EvernoteNoteStore.hgetResourceApplicationDataWithGuid:success:failure:
Get all of the application data for the Resource identified by GUID, with values returned within the LazyMap fullMap field. If there are no applicationData entries, then a LazyMap with an empty fullMap will be returned. If your application only needs to fetch its own applicationData entry, use getResourceApplicationDataEntry instead.
- (void)getResourceApplicationDataWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( EDAMLazyMap *map ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the Resource.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Get all of the application data for the Resource identified by GUID, with values returned within the LazyMap fullMap field. If there are no applicationData entries, then a LazyMap with an empty fullMap will be returned. If your application only needs to fetch its own applicationData entry, use getResourceApplicationDataEntry instead.
Declared In
EvernoteNoteStore.hgetResourceAttributesWithGuid:success:failure:
Returns the set of attributes for the Resource with the provided GUID. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
- (void)getResourceAttributesWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( EDAMResourceAttributes *attributes ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
-
The GUID of the resource whose attributes should be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns the set of attributes for the Resource with the provided GUID. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
Declared In
EvernoteNoteStore.hgetResourceByHashWithGuid:contentHash:withData:withRecognition:withAlternateData:success:failure:
Returns the current state of a resource, referenced by containing note GUID and resource content hash.
- (void)getResourceByHashWithGuid:(EDAMGuid)guid
contentHash:(NSData *)contentHash withData:(BOOL)withData
withRecognition:(BOOL)withRecognition
withAlternateData:(BOOL)withAlternateData
success:(void ( ^ ) ( EDAMResource *resource ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
-
The GUID of the note that holds the resource to be retrieved.
- contentHash
-
The MD5 checksum of the resource within that note. Note that this is the binary checksum, for example from Resource.data.bodyHash, and not the hex-encoded checksum that is used within an en-media tag in a note body.
- withData
-
If true, the Resource will include the binary contents of the ‘data’ field’s body.
- withRecognition
-
If true, the Resource will include the binary contents of the ‘recognition’ field’s body.
- withAlternateData
-
If true, the Resource will include the binary contents of the ‘alternateData’ field’s body, if an alternate form is present.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns the current state of a resource, referenced by containing note GUID and resource content hash.
Declared In
EvernoteNoteStore.hgetResourceDataWithGuid:success:failure:
Returns binary data of the resource with the provided GUID.
- (void)getResourceDataWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSData *data ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the resource to be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns binary data of the resource with the provided GUID.
For example, if this were an image resource, this would contain the raw bits of the image. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
Declared In
EvernoteNoteStore.hgetResourceRecognitionWithGuid:success:failure:
Returns the binary contents of the recognition index for the resource with the provided GUID.
- (void)getResourceRecognitionWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSData *data ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
-
The GUID of the resource whose recognition data should be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns the binary contents of the recognition index for the resource with the provided GUID.
If the caller asks about a resource that has no recognition data, this will throw EDAMNotFoundException. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
Declared In
EvernoteNoteStore.hgetResourceSearchTextWithGuid:success:failure:
Returns a block of the extracted plain text contents of the resource with the provided GUID.
- (void)getResourceSearchTextWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSString *text ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the resource to be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a block of the extracted plain text contents of the resource with the provided GUID.
This text can be indexed for search purposes by a light client that doesn’t have capability to extract all of the searchable text content from a resource. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
Declared In
EvernoteNoteStore.hgetResourceWithGuid:withData:withRecognition:withAttributes:withAlternateDate:success:failure:
Returns the current state of the resource in the service with the provided GUID.
- (void)getResourceWithGuid:(EDAMGuid)guid
withData:(BOOL)withData withRecognition:(BOOL)withRecognition
withAttributes:(BOOL)withAttributes
withAlternateDate:(BOOL)withAlternateData
success:(void ( ^ ) ( EDAMResource *resource ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the resource to be retrieved.
- withData
-
If true, the Resource will include the binary contents of the ‘data’ field’s body.
- withRecognition
-
If true, the Resource will include the binary contents of the ‘recognition’ field’s body if recognition data is present.
- withAttributes
-
If true, the Resource will include the attributes
- withAlternateData
-
If true, the Resource will include the binary contents of the ‘alternateData’ field’s body, if an alternate form is present.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns the current state of the resource in the service with the provided GUID.
If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string). Only the keys for the applicationData will be returned.
Declared In
EvernoteNoteStore.hgetSearchWithGuid:success:failure:
Returns the current state of the search with the provided GUID.
- (void)getSearchWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( EDAMSavedSearch *search ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the search to be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns the current state of the search with the provided GUID.
Declared In
EvernoteNoteStore.hgetSharedNotebookByAuthWithSuccess:failure:
This function is used to retrieve extended information about a shared notebook by a guest who has already authenticated to access that notebook.
- (void)getSharedNotebookByAuthWithSuccess:(void ( ^ ) (
EDAMSharedNotebook *sharedNotebook ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
This function is used to retrieve extended information about a shared notebook by a guest who has already authenticated to access that notebook.
This requires an ‘authenticationToken’ parameter which should be the resut of a call to authenticateToSharedNotebook(…). I.e. this is the token that gives access to the particular shared notebook in someone else’s account — it’s not the authenticationToken for the owner of the notebook itself.
Declared In
EvernoteNoteStore.hgetSyncChunkAfterUSN:maxEntries:fullSyncOnly:success:failure:
Asks the NoteStore to provide the state of the account in order of last modification.
- (void)getSyncChunkAfterUSN:(int32_t)afterUSN
maxEntries:(int32_t)maxEntries fullSyncOnly:(BOOL)fullSyncOnly
success:(void ( ^ ) ( EDAMSyncChunk *syncChunk ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- afterUSN
-
The client can pass this value to ask only for objects that have been updated after a certain point. This allows the client to receive updates after its last checkpoint rather than doing a full synchronization on every pass. The default value of “0” indicates that the client wants to get objects from the start of the account.
- maxEntries
-
The maximum number of modified objects that should be returned in the result SyncChunk. This can be used to limit the size of each individual message to be friendly for network transfer. Applications should not request more than 256 objects at a time, and must handle the case where the service returns less than the requested number of objects in a given request even though more objects are available on the service.
- fullSyncOnly
-
If true, then the client only wants initial data for a full sync. In this case, the service will not return any expunged objects, and will not return any Resources, since these are also provided in their corresponding Notes.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the NoteStore to provide the state of the account in order of last modification.
This request retrieves one block of the server’s state so that a client can make several small requests against a large account rather than getting the entire state in one big message.
Declared In
EvernoteNoteStore.hgetSyncStateWithSuccess:failure:
Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token.
- (void)getSyncStateWithSuccess:(void ( ^ ) ( EDAMSyncState
*syncState ))success failure:(void ( ^ ) ( NSError
*error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token.
Declared In
EvernoteNoteStore.hgetTagWithGuid:success:failure:
Asks the service to make a tag with a set of information.
- (void)getTagWithGuid:(EDAMGuid)guid success:(void
( ^ ) ( EDAMTag *tag ))success failure:(void ( ^ ) (
NSError *error ))failure
Parameters
- guid
The GUID of the tag to be retrieved.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the service to make a tag with a set of information.
Declared In
EvernoteNoteStore.hinitWithSession:
Construct an instance with the given session.
- (id)initWithSession:(EvernoteSession *)session
Parameters
- session
The Evernote session object
Discussion
Construct an instance with the given session.
Declared In
EvernoteNoteStore.hisBusinessNotebookWritable:success:failure:
Check if the business notebook is writable.
- (void)isBusinessNotebookWritable:(EDAMLinkedNotebook *)linkedNotebook
success:(void ( ^ ) ( BOOL isWritable ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- linkedNotebook
-
Details on the business notebook to be checked.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Check if the business notebook is writable.
This is a utility function that makes it easier to find if a business notebook is writable for this user.
Declared In
EvernoteNoteStore+Extras.hlistBusinessNotebooksWithSuccess:failure:
List all the business notebooks in a users account.
- (void)listBusinessNotebooksWithSuccess:(void ( ^ ) (
NSArray *linkedNotebooks ))success failure:(void ( ^
) ( NSError *error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
List all the business notebooks in a users account.
This is a utility function that makes it easier to access all the business notebooks. Internally, it does the authentication to Business for you.
Declared In
EvernoteNoteStore+Extras.hlistLinkedNotebooksWithSuccess:failure:
Returns a list of linked notebooks
- (void)listLinkedNotebooksWithSuccess:(void ( ^ ) ( NSArray
*linkedNotebooks ))success failure:(void ( ^ ) (
NSError *error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a list of linked notebooks
Declared In
EvernoteNoteStore.hlistNoteVersionsWithGuid:success:failure:
Returns a list of the prior versions of a particular note that are saved within the service.
- (void)listNoteVersionsWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSArray *versions ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the Note.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a list of the prior versions of a particular note that are saved within the service.
These prior versions are stored to provide a recovery from unintentional removal of content from a note. The identifiers that are returned by this call can be used with getNoteVersion to retrieve the previous note. The identifiers will be listed from the most recent versions to the oldest.
Declared In
EvernoteNoteStore.hlistNotebooksWithSuccess:failure:
Returns a list of all of the notebooks in the account.
- (void)listNotebooksWithSuccess:(void ( ^ ) ( NSArray
*notebooks ))success failure:(void ( ^ ) ( NSError
*error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a list of all of the notebooks in the account.
Declared In
EvernoteNoteStore.hlistNotesForLinkedNotebook:withFilter:success:failure:
Asks the NoteStore to all the notes in the given linked notebook.
- (void)listNotesForLinkedNotebook:(EDAMLinkedNotebook *)linkedNotebook
withFilter:(EDAMNoteFilter *)filter success:(void ( ^
) ( EDAMNoteList *list ))success failure:(void ( ^ )
( NSError *error ))failure
Parameters
- linkedNotebook
-
The linked notebook, this can be retrieved using listLinkedNotebooksWithSuccess:failure: or createLinkedNotebook:success:failure:
- filter
The filter to be used
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the NoteStore to all the notes in the given linked notebook.
This is a utility function that makes it easier to access notes in the linked notebooks. Internally, it does the authentication(to the linked notebook) for you.
Declared In
EvernoteNoteStore+Extras.hlistSearchesWithSuccess:failure:
Returns a list of the searches in the account. Evernote does not support the undeletion of searches, so this will only include active searches.
- (void)listSearchesWithSuccess:(void ( ^ ) ( NSArray
*searches ))success failure:(void ( ^ ) ( NSError
*error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a list of the searches in the account. Evernote does not support the undeletion of searches, so this will only include active searches.
Declared In
EvernoteNoteStore.hlistSharedNotebooksWithSuccess:failure:
Lists the collection of shared notebooks for all notebooks in the users account.
- (void)listSharedNotebooksWithSuccess:(void ( ^ ) ( NSArray
*sharedNotebooks ))success failure:(void ( ^ ) (
NSError *error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
Lists the collection of shared notebooks for all notebooks in the users account.
Declared In
EvernoteNoteStore.hlistTagsByNotebookWithGuid:success:failure:
Returns a list of the tags that are applied to at least one note within the provided notebook. If the notebook is public, the authenticationToken may be ignored.
- (void)listTagsByNotebookWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSArray *tags ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
the GUID of the notebook to use to find tags
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a list of the tags that are applied to at least one note within the provided notebook. If the notebook is public, the authenticationToken may be ignored.
Declared In
EvernoteNoteStore.hlistTagsWithSuccess:failure:
Returns a list of the tags in the account. Evernote does not support the undeletion of tags, so this will only include active tags.
- (void)listTagsWithSuccess:(void ( ^ ) ( NSArray *tags ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- success
Success completion block.
- failure
Failure completion block.
Discussion
Returns a list of the tags in the account. Evernote does not support the undeletion of tags, so this will only include active tags.
Declared In
EvernoteNoteStore.hsaveNewNoteToEvernoteApp:withType:
Save a new note to the Evernote for iOS app
- (void)saveNewNoteToEvernoteApp:(EDAMNote *)note
withType:(NSString *)contentMimeType
Parameters
- note
The note that needs to be saved.
- contentMimeType
This can be either text/plain or text/html.
Discussion
Save a new note to the Evernote for iOS app
After completetion the ENSessionDelegate will be used to confirm success or failure.
Declared In
EvernoteNoteStore+Extras.hsendMessageToSharedNotebookMembersWithGuid:messageText:recipients:success:failure:
Send a reminder message to some or all of the email addresses that a notebook has been shared with.
-
(void)sendMessageToSharedNotebookMembersWithGuid:(EDAMGuid)guid
messageText:(NSString *)messageText
recipients:(NSMutableArray *)recipients success:(void
( ^ ) ( int32_t numMessagesSent ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The guid of the shared notebook
- messageText
User provided text to include in the email
- recipients
-
The email addresses of the recipients. If this list is empty then all of the users that the notebook has been shared with are emailed. If an email address doesn’t correspond to share invite members then that address is ignored.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Send a reminder message to some or all of the email addresses that a notebook has been shared with.
The message includes the current link to view the notebook.
Declared In
EvernoteNoteStore.hsetNoteApplicationDataEntryWithGuid:key:value:success:failure:
Update, or create, an entry in the applicationData map for the note identified by guid.
- (void)setNoteApplicationDataEntryWithGuid:(EDAMGuid)guid
key:(NSString *)key value:(NSString *)value
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note
- key
The key in the dictionary
- value
The value in the dictionary
- success
Success completion block.
- failure
Failure completion block.
Discussion
Update, or create, an entry in the applicationData map for the note identified by guid.
Declared In
EvernoteNoteStore.hsetResourceApplicationDataEntryWithGuid:key:value:success:failure:
Update, or create, an entry in the applicationData map for the Resource identified by guid.
- (void)setResourceApplicationDataEntryWithGuid:(EDAMGuid)guid
key:(NSString *)key value:(NSString *)value
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the Resource.
- key
key in the dictionary
- value
value in the dictionary
- success
Success completion block.
- failure
Failure completion block.
Discussion
Update, or create, an entry in the applicationData map for the Resource identified by guid.
Declared In
EvernoteNoteStore.hshareNoteWithGuid:success:failure:
If this note is not already shared (via its own direct URL), then this will start sharing that note.
- (void)shareNoteWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( NSString *noteKey ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note to be shared.
- success
Success completion block.
- failure
Failure completion block.
Discussion
If this note is not already shared (via its own direct URL), then this will start sharing that note.
This will return the secret “Note Key” for this note that can currently be used in conjunction with the Note’s GUID to gain direct read-only access to the Note. If the note is already shared, then this won’t make any changes to the note, and the existing “Note Key” will be returned. The only way to change the Note Key for an existing note is to stopSharingNote first, and then call this function.
Declared In
EvernoteNoteStore.hstopSharingNoteWithGuid:success:failure:
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. If the Note is not shared, then this function will do nothing.
- (void)stopSharingNoteWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( ))success failure:(void ( ^ ) (
NSError *error ))failure
Parameters
- guid
The GUID of the note to be un-shared.
- success
Success completion block.
- failure
Failure completion block.
Discussion
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. If the Note is not shared, then this function will do nothing.
Declared In
EvernoteNoteStore.hunsetNoteApplicationDataEntryWithGuid:key:success:failure:
Remove an entry identified by ‘key’ from the applicationData map for the note identified by ‘guid’. Silently ignores an unset of a non-existing key.
- (void)unsetNoteApplicationDataEntryWithGuid:(EDAMGuid)guid
key:(NSString *)key success:(void ( ^ ) ( int32_t usn
))success failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the note
- key
key from applicationData map
- success
Success completion block.
- failure
Failure completion block.
Discussion
Remove an entry identified by ‘key’ from the applicationData map for the note identified by ‘guid’. Silently ignores an unset of a non-existing key.
Declared In
EvernoteNoteStore.hunsetResourceApplicationDataEntryWithGuid:key:success:failure:
Remove an entry identified by ‘key’ from the applicationData map for the Resource identified by ‘guid’.
-
(void)unsetResourceApplicationDataEntryWithGuid:(EDAMGuid)guid
key:(NSString *)key success:(void ( ^ ) ( int32_t usn
))success failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- guid
The GUID of the Resource.
- key
key in the dictionary
- success
Success completion block.
- failure
Failure completion block.
Discussion
Remove an entry identified by ‘key’ from the applicationData map for the Resource identified by ‘guid’.
Declared In
EvernoteNoteStore.huntagAllWithGuid:success:failure:
Removes the provided tag from every note that is currently tagged with this tag. If this operation is successful, the tag will still be in the account, but it will not be tagged on any notes.
- (void)untagAllWithGuid:(EDAMGuid)guid
success:(void ( ^ ) ( ))success failure:(void ( ^ ) (
NSError *error ))failure
Parameters
- guid
The GUID of the tag to remove from all notes.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Removes the provided tag from every note that is currently tagged with this tag. If this operation is successful, the tag will still be in the account, but it will not be tagged on any notes.
This function is not indended for use by full synchronizing clients, since it does not provide enough result information to the client to reconcile the local state without performing a follow-up sync from the service. This is intended for “thin clients” that need to efficiently support this as a UI operation.
Declared In
EvernoteNoteStore.hupdateLinkedNotebook:success:failure:
Asks the service to update a linked notebook.
- (void)updateLinkedNotebook:(EDAMLinkedNotebook *)linkedNotebook
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- linkedNotebook
Updates the name of a linked notebook.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Asks the service to update a linked notebook.
Declared In
EvernoteNoteStore.hupdateNote:success:failure:
Submit a set of changes to a note to the service.
- (void)updateNote:(EDAMNote *)note success:(void (
^ ) ( EDAMNote *note ))success failure:(void ( ^ ) (
NSError *error ))failure
Parameters
- 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.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Submit a set of changes to a note to the service.
The provided data must include the note’s guid field for identification. The note’s title must also be set.
Declared In
EvernoteNoteStore.hupdateNotebook:success:failure:
Submits notebook changes to the service. The provided data must include the notebook’s guid field for identification.
- (void)updateNotebook:(EDAMNotebook *)notebook
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- notebook
-
The notebook object containing the requested changes.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Submits notebook changes to the service. The provided data must include the notebook’s guid field for identification.
Declared In
EvernoteNoteStore.hupdateResource:success:failure:
Submit a set of changes to a resource to the service.
- (void)updateResource:(EDAMResource *)resource
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- resource
-
A Resource object containing the desired fields to be populated on the service. The service will attempt to update the resource with the following fields from the client: guid(must be provided to identify the resource),mime,width,height,duration,attributes(optional. if present, the set of attributes will be replaced).
- success
Success completion block.
- failure
Failure completion block.
Discussion
Submit a set of changes to a resource to the service.
This can be used to update the meta-data about the resource, but cannot be used to change the binary contents of the resource (including the length and hash). These cannot be changed directly without creating a new resource and removing the old one via updateNote.
Declared In
EvernoteNoteStore.hupdateSearch:success:failure:
Submits search changes to the service. The provided data must include the search’s guid field for identification. The service will apply updates to the following search fields: name, query, and format.
- (void)updateSearch:(EDAMSavedSearch *)search
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- search
-
The search object containing the requested changes.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Submits search changes to the service. The provided data must include the search’s guid field for identification. The service will apply updates to the following search fields: name, query, and format.
Declared In
EvernoteNoteStore.hupdateSharedNotebook:success:failure:
Update a SharedNotebook object.
- (void)updateSharedNotebook:(EDAMSharedNotebook *)sharedNotebook
success:(void ( ^ ) ( int32_t usn ))success
failure:(void ( ^ ) ( NSError *error ))failure
Parameters
- sharedNotebook
-
The SharedNotebook object containing the requested changes. The “id” of the shared notebook must be set to allow the service to identify the SharedNotebook to be updated. In addition, you MUST set the email, permission, and allowPreview fields to the desired values. All other fields will be ignored if set.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Update a SharedNotebook object.
Declared In
EvernoteNoteStore.hupdateTag:success:failure:
Submits tag changes to the service. The provided data must include the tag’s guid field for identification. The service will apply updates to the following tag fields: name, parentGuid
- (void)updateTag:(EDAMTag *)tag success:(void ( ^ )
( int32_t usn ))success failure:(void ( ^ ) ( NSError
*error ))failure
Parameters
- tag
-
The tag object containing the requested changes.
- success
Success completion block.
- failure
Failure completion block.
Discussion
Submits tag changes to the service. The provided data must include the tag’s guid field for identification. The service will apply updates to the following tag fields: name, parentGuid
Declared In
EvernoteNoteStore.hviewNoteInEvernote:
View a note using the Evernote for iOS app
- (void)viewNoteInEvernote:(EDAMNote *)note
Parameters
- note
The note that needs to be viewed.
Discussion
View a note using the Evernote for iOS app
After completetion the ENSessionDelegate will be used to confirm success or failure.
Declared In
EvernoteNoteStore+Extras.h