Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evernote/evernote-sdk-android
Evernote SDK for Android
https://github.com/evernote/evernote-sdk-android
Last synced: 1 day ago
JSON representation
Evernote SDK for Android
- Host: GitHub
- URL: https://github.com/evernote/evernote-sdk-android
- Owner: Evernote
- Created: 2012-04-24T19:14:31.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2023-06-02T14:55:53.000Z (over 1 year ago)
- Last Synced: 2024-12-23T06:06:07.884Z (18 days ago)
- Language: Java
- Size: 10.4 MB
- Stars: 430
- Watchers: 60
- Forks: 168
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Evernote SDK for Android version 2.0.0-RC4
==========================================
Evernote API version 1.25
Overview
--------
This SDK wraps the [Evernote Cloud API ](http://dev.evernote.com/documentation/cloud/) and provides OAuth authentication functionality. The SDK is provided as an Android Library project that can be included in your application with Gradle.
Prerequisites
-------------
In order to use the code in this SDK, you need to obtain an API key from https://dev.evernote.com/doc/. You'll also find full API documentation on that page.
In order to run the demo code, you need a user account on the sandbox service where you will do your development. Sign up for an account at https://sandbox.evernote.com/Registration.action
The instructions below assume you have the latest [Android SDK](http://developer.android.com/sdk/index.html).
Download
--------
Add the library as a dependency in your build.gradle file.
```groovy
dependencies {
compile 'com.evernote:android-sdk:2.0.0-RC4'
}
```
##### (Optional) Using a snapshot build for early access previews
Add Sonatype's snapshot repository in your build script.
```groovy
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
```
Add the snapshot depdendency.
```groovy
dependencies {
compile 'com.evernote:android-sdk:2.0.0-SNAPSHOT'
}
```
Demo App
--------
The demo application 'Evernote SDK Demo' demonstrates how to use the Evernote SDK for Android to authentication to the Evernote service using OAuth, then access the user's Evernote account. The demo code provides multiple activities that show notebook listing, note creation, and resource creation in two scenarios: A plain text note creator and an image saver.
#### Running the demo app from Android Studio
To build and run the demo project from Android Studio:
1. Open Android Studio
2. Choose Import Project (Eclipse ADT, Gradle, etc.)
3. Select the SDK root directory (the directory containing this README) and click OK
4. Add your Evernote API consumer key and secret (see below)
##### Adding Evernote API consumer key and secret
You have two different options to add your consumer key and secret.
###### gradle.properties file (preferred)
1. Open the folder `~/.gradle` in your user's home directory.
2. Open or create a file called `gradle.properties`
3. Add a line `EVERNOTE_CONSUMER_KEY=Your Consumer Key`
4. Add a line `EVERNOTE_CONSUMER_SECRET=Your Consumer Secret`
###### In code
1. Open the class `com.evernote.android.demo.DemoApp.java`
2. At the top of `DemoApp.java`, fill in your Evernote API consumer key and secret.
Usage SDK
---------
#### Modify your `AndroidManifest.xml`
The SDK's OAuth functionality is implemented as an Android Activity that must be declared in your app's `AndroidManifest.xml`.
Starting with Android Gradle plugin version 1.0.0 the necessary activities are merged in your app's `AndroidManifest.xml` file and you don't need to do anything. Otherwise simply copy and paste the following snippet into your `AndroidManifest.xml` within the application section:
```xml
```
#### Set up an `EvernoteSession`
Define your app credentials (key, secret, and host). See http://dev.evernote.com/documentation/cloud/
```java
private static final String CONSUMER_KEY = "Your consumer key";
private static final String CONSUMER_SECRET = "Your consumer secret";
private static final EvernoteSession.EvernoteService EVERNOTE_SERVICE = EvernoteSession.EvernoteService.SANDBOX;
```
When your app starts, initialize the EvernoteSession singleton that has all of the information that is needed to authenticate to Evernote. The EvernoteSession instance of saved statically and does not need to be passed between activities. The better option is to build the instance in your onCreate() of the Application object or your parent Activity object.
```java
mEvernoteSession = new EvernoteSession.Builder(this)
.setEvernoteService(EVERNOTE_SERVICE)
.setSupportAppLinkedNotebooks(SUPPORT_APP_LINKED_NOTEBOOKS)
.build(consumerKey, consumerSecret)
.asSingleton();
```
#### Give the user a way to initiate authentication
In our demo app, we have a "Login" button that initiates the authentication process. You might choose to do something similar, or you might simply initiate authentication the first time that the user tries to access Evernote-related functionality.
The recommended approach is to use `FragmentActivity`s. Then the authentication process opens a dialog and no extra `Activity`. But normal `Activity`s are supported as well.
```java
mEvernoteSession.authenticate(this);
```
### Evernote and Yinxiang Biji Service Bootstrapping
The Activity that completes the OAuth authentication automatically determines if the User is on the Evernote service or the Yinxiang service and configures the end points automatically.
If you want to test if bootstrapping works within your app, you can either change the device's language to Chinese or you can set a specific Locale object in the session builder, e.g. `new EvernoteSession.Builder(this).setLocale(Locale.SIMPLIFIED_CHINESE)`. If the SDK can't decide which server to use, then the user has the option to change the Evernote service while authenticating.
#### Complete authentication
If you use a `FragmentActivity`, you should implement the `EvernoteLoginFragment.ResultCallback` interface.
```java
public class MyActivity extends Activity implements EvernoteLoginFragment.ResultCallback {
// ...
@Override
public void onLoginFinished(boolean successful) {
// handle result
}
}
```
If you use a normal `Activity`, you should override `onActivityResult`.
```java
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
switch (requestCode) {
case EvernoteSession.REQUEST_CODE_LOGIN:
if (resultCode == Activity.RESULT_OK) {
// handle success
} else {
// handle failure
}
break;
default:
super.onActivityResult(requestCode, resultCode, data);
break;
}
}
```
Snippets
--------
Calling `EvernoteSession.getEvernoteClientFactory()` will give you access to async wrappers around `NoteStore.Client` or `UserStore.Client`. Browse the API JavaDocs at http://dev.evernote.com/documentation/reference/javadoc/
The `EvernoteClientFactory` also creates multiple helper classes, e.g. `EvernoteHtmlHelper` to download a note as HTML.
Create an `EvernoteNoteStoreClient` to access primary methods for personal note data
```java
EvernoteSession.getInstance().getEvernoteClientFactory().getNoteStoreClient();
```
Create an `EvernoteUserStoreClient` to access User related methods
```java
EvernoteSession.getInstance().getEvernoteClientFactory().getUserStoreClient();
```
Create an `EvernoteBusinessNotebookHelper` to access Business Notebooks
```java
EvernoteSession.getInstance().getEvernoteClientFactory().getBusinessNotebookHelper();
```
Create an `EvernoteLinkedNotebookHelper` to access shared notebooks
```java
EvernoteSession.getInstance().getEvernoteClientFactory().getLinkedNotebookHelper(linkedNotebook);
```
###### Getting list of notebooks asynchronously
```java
if (!EvernoteSession.getInstance().isLoggedIn()) {
return;
}
EvernoteNoteStoreClient noteStoreClient = EvernoteSession.getInstance().getEvernoteClientFactory().getNoteStoreClient();
noteStoreClient.listNotebooksAsync(new EvernoteCallback>() {
@Override
public void onSuccess(List result) {
List namesList = new ArrayList<>(result.size());
for (Notebook notebook : result) {
namesList.add(notebook.getName());
}
String notebookNames = TextUtils.join(", ", namesList);
Toast.makeText(getApplicationContext(), notebookNames + " notebooks have been retrieved", Toast.LENGTH_LONG).show();
}
@Override
public void onException(Exception exception) {
Log.e(LOGTAG, "Error retrieving notebooks", exception);
}
});
```
###### Creating a note asynchronously
```java
if (!EvernoteSession.getInstance().isLoggedIn()) {
return;
}
EvernoteNoteStoreClient noteStoreClient = EvernoteSession.getInstance().getEvernoteClientFactory().getNoteStoreClient();
Note note = new Note();
note.setTitle("My title");
note.setContent(EvernoteUtil.NOTE_PREFIX + "My content" + EvernoteUtil.NOTE_SUFFIX);
noteStoreClient.createNoteAsync(note, new EvernoteCallback() {
@Override
public void onSuccess(Note result) {
Toast.makeText(getApplicationContext(), result.getTitle() + " has been created", Toast.LENGTH_LONG).show();
}
@Override
public void onException(Exception exception) {
Log.e(LOGTAG, "Error creating note", exception);
}
});
```
###### Using the `EvernoteBusinessNotebookHelper` to Access Evernote Business data
1. Check if user is member of a business
2. Create `EvernoteBusinessNotebookHelper`
3. Call synchronous methods from a background thread or call async methods from UI thread
This note store is not long lived, the Business authentication token expires frequently and is refreshed if needed in the `getBusinessNotebookHelper()` method.
Example using the synchronous business methods inside a background thread to create a note in a business account
```java
new Thread() {
@Override
public void run() {
try {
if (!EvernoteSession.getInstance().getEvernoteClientFactory().getUserStoreClient().isBusinessUser()) {
Log.d(LOGTAG, "Not a business User");
return;
}
EvernoteBusinessNotebookHelper businessNotebookHelper = EvernoteSession.getInstance().getEvernoteClientFactory().getBusinessNotebookHelper();
List businessNotebooks = businessNotebookHelper.listBusinessNotebooks(EvernoteSession.getInstance());
if (businessNotebooks.isEmpty()) {
Log.d(LOGTAG, "No business notebooks found");
}
LinkedNotebook linkedNotebook = businessNotebooks.get(0);
Note note = new Note();
note.setTitle("My title");
note.setContent(EvernoteUtil.NOTE_PREFIX + "My content" + EvernoteUtil.NOTE_SUFFIX);
EvernoteLinkedNotebookHelper linkedNotebookHelper = EvernoteSession.getInstance().getEvernoteClientFactory().getLinkedNotebookHelper(linkedNotebook);
final Note createdNote = linkedNotebookHelper.createNoteInLinkedNotebook(note);
runOnUiThread(new Runnable() {
@Override
public void run() {
Toast.makeText(getApplicationContext(), createdNote.getTitle() + " has been created.", Toast.LENGTH_LONG).show();
}
});
} catch (TException | EDAMUserException | EDAMSystemException | EDAMNotFoundException e) {
e.printStackTrace();
}
}
}.start();
```
License
=======
Copyright (c) 2007-2015 by Evernote Corporation, All rights reserved.
Use of the source code and binary libraries included in this package
is permitted under the following terms:
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.