Evernote Shard

admin



Notebook Sharing

Evernote Share Stack

Sharing notebooks with individuals and with the world

Overview

All aspects of Evernote’s notebook sharing capabilities are available to third-party developers via the Evernote API. This functionality can be a little difficult to understand at first, so this document will cover all related concepts in detail. First, some vocabulary:

  • Perfect for capturing meetings, lectures, and more. You can now play back existing audio files inside your notes. Drag-and-drop files onto a space or shortcut in the sidebar to add them to a space, notebook, or stack. Evernote Business customers: Published notebooks are back! Create notebooks and easily share them with your entire.
  • Get organized and productive with the leading note-taking app. Download Evernote for Windows, Mac, iOS, or Android and create your free account.

The Evernote service can create a LinkedNotebook when a user views a shared notebook invitation in their browser, or your application can programmatically accept the share and create the LinkedNotebook in the recipient's account.

  • A Shared Notebook is accessible to users other than the notebook owner: either specific individuals or the world. The SharedNotebook type controls how and with whom a notebook is shared.
  • A Linked Notebook is a reference in one user's account to a notebook that has been shared by another user. The LinkedNotebook defines this relationship between the shared notebook and the subscriber.

For example: if Bob creates a notebook in his account called “Fishing” and shares it with Susan, a SharedNotebook instance is created on Bob’s account which contains information about Susan (including her email address) and sent to the Evernote API. When Susan accepts the invitation, a LinkedNotebook instance is created in Susan's account which points to Bob’s SharedNotebook instance.

Here’s a simple graphic illustrating these principles:

Sharing a notebook with a single person

To share a notebook with a single person, you need three things (aside from an authenticated instance of NoteStore):

  1. The GUID of the Notebook you’d like to share.
  2. The email address of the person with whom you’d like to share the notebook.
  3. The desired priviledge level (which are collected in the SharedNotebookPrivilegeLevel enumeration).

Here is a short example demonstrating how to create a new notebook and share it:

We begin by creating a new instance of Notebook and giving it a value for name. After notebook is then created on the Evernote service (using NoteStore.createNotebook), we’ll have the GUID of the notebook that we’ll use to share it.

Then, we create an instance of SharedNotebook. This type can be described as establishing the relationship between the notebook and the person with whom it is being shared. By populating the notebookGuid and email attributes of the SharedNotebook instance, we create this relationship. Finally, we assign the desired privilege level using the privilege attribute on the SharedNotebook, which will be a member of the SharedNotebookPrivilegeLevel enumeration (see the docs for a description of each option).

Evernote share notebook stack

Finally, we send the SharedNotebook to Evernote by calling NoteStore.createSharedNotebook. If you run the sample code above, you’ll see something like this in the sharing preferences for the notebook we created:

A couple of other things about shared notebooks:

  • To share a notebook with multiple individuals, a separate instance of SharedNotebook must be used for each person. In other words, SharedNotebook represents a relationship between a notebook and a single recipient. Each notebook contains a sharedNotebooks collection containing these instances.
  • To stop sharing a notebook with a specific individual, you must call NoteStore.expungeSharedNotebooks and include the identifier for the correct SharedNotebook. Note that this function requires special permission from Evernote; if you need access to this functionality, get in touch with us.
  • Be sure to set the allowPreview boolean on the Notebook object to whichever value is appropriate. If the value is unset, the Evernote API will throw an exception indicating that requireLogin is invalid. Leave requireLogin unset (as it is deprecated).
Sharing a notebook with the world

Making a notebook publicly visible is a bit easier than sharing with specific people. To share a notebook with the world, you need only set a couple of attributes on the Notebook object and call NoteStore.updateNotebook:

The salient portions here deal with the published and publishing attributes on the notebook:

Evernote Shard Quest

  • published is a boolean that controls whether the notebook is publicly shared. To share a given notebook, set this value to true.
  • publishing is an instance of the Publishing type. At minimum, the uri attribute (which controls the ending portion of the sharing URL) must be defined for the notebook to be publicly visible on the web. All other fields are optional and, in the case of ascending, assigned a default value by the Evernote service if not manually set.

To stop sharing a notebook publicly, simply set the published attribute to false and call NoteStore.updateNotebook.

Sharing Notes

Private and public note sharing

A user can share his or her Evernote notes and notebooks with a specific user, a certain group of users or the world.

This diagram shows the different sharing options in Evernote:

Sharing options

[1] Generate unique URL giving access to everybody who knows the URL

[2] Grant access to a specific notebook to specific Evernote users

[3] Make a notebook public and share it with the world

Sharing a single note

Sharing a single note by URL

You can also share a single note by generating a URL that will allow anybody who knows the URL to view the note in a browser. The URL always shares the current content of the note, so if the note is changed after it is shared, the recipients will see the changes.

Important

An application may only turn on sharing for a note when the user explicitly chooses to do so - for example by tapping a 'share' button. You may never enable sharing without the user's explicit consent.

To enable sharing by URL for a note, you must first turn on sharing using shareNote. This will generate a share key, which you can then use to assemble the URL:

https://host.evernote.com/shard/shardId/sh/noteGuid/noteKey

For example:

In the URL above, the shardId is s1, the note's GUID is 3554a82b-54d3-4673-8641-2bbcac94bbff, and the share key is d368012bd2c3ce342c709fefd26355a7.

Evernote Shared With Me

Sharing can be turned off for a given note using stopSharingNote. Once stopSharingNote has been called, previously shared URLs will stop working. If sharing is later re-enabled, a new share key will be generated and a new URL will need to be assembled.

An application can also read a shared single note if it has the components used to assemble the sharing URL. Here's how your can read the note that I shared above:

Programmatically reading a shared single note (PHP)

Sharing entire notebooks

Users can also share entire notebooks, either with specific recipients or publicly. Notebooks that are shared with specific recipients can optionally require the recipient to log into Evernote to view the shared notebook. Premium users can also allow recipients to modify the notes within a shared notebook. Because of the number of possible configurations, sharing notebooks is relatively complex.

There are two data model objects involved in sharing notebooks - SharedNotebook and LinkedNotebook. The SharedNotebook object lives in the notebook owner's account - think of it as an invitation to view a specific notebook. The LinkedNotebook object lives in the share recipient's account and represents a persistent link to the notebook in the owner's account. Because users can view shared notebooks without logging into Evernote (if the notebook owner allows them to), there doesn't need to be a LinkedNotebook for every SharedNotebook.

Sharing a notebook

To share a notebook, you create a SharedNotebook object in the notebook owner's account. A SharedNotebook shares the notebook with a single email address, so to share a notebook with three friends, you will create three SharedNotebook objects.

Sharing a notebook with a single recipient (PHP)

Creating a SharedNotebook doesn't automatically generate an invitation to the recipient. If your application turns on sharing for a notebook by creating a SharedNotebook, you will need to ensure that the recipient receives the information that they need to access the share. Similarly, LinkedNotebooks are not created automatically. The Evernote service can create a LinkedNotebook when a user views a shared notebook invitation in their browser, or your application can programmatically accept the share and create the LinkedNotebook in the recipient's account.

Reading notes from linked notebooks

When your application accesses a user's Evernote account through the Cloud API, you can get a list of LinkedNotebooks - notebooks owned by another user that have been shared with your user. Once you have that list, you can acess the notes in the owner's notebook. To do this, you need to create a second NoteStore connection, since the owner's account and the recipient's account may be on different shards. Using that NoteStore connection, you can obtain a second authentication token that will allow you to access the contents of the shared notebook.

Evernote Shard Download

Once you have an authentication token to read from the shared notebook, you can use any of the NoteStore functions to interact with the notes in that notebook. The sample code above uses findNotes to get all of the notes in the shared notebook. Note that you need to you must set the NoteFilter.notebookGuid to the appropriate notebook GUID when using findNotes and findNotesMetadata on a shared notebook.

Synchronizing linked notebooks

Evernote Share Notebook Stack

Usb guitar link driver free download. For a complete guide on synchronizing linked notebooks, download the synchronizing guide.