com.evernote.client.android

Class EvernoteSession

java.lang.Object

com.evernote.client.android.EvernoteSession

public final class EvernoteSession
extends java.lang.Object

Represents a session with the Evernote web service API. Used to authenticate to the service via OAuth and obtain NoteStore.Client objects, which are used to make authenticated API calls. To use EvernoteSession, first initialize the EvernoteSession singleton with the EvernoteSession.Builder class and call asSingleton(). After that initiate authentication at an appropriate time:

 EvernoteSession evernoteSession = new EvernoteSession.Builder(this)
      .setEvernoteService(EvernoteSession.EvernoteService.PRODUCTION)
      .setSupportAppLinkedNotebooks(SUPPORT_APP_LINKED_NOTEBOOKS)
      .build(consumerKey, consumerSecret)
      .asSingleton();

 if (!session.isLoggedIn()) {
      session.authenticate(...);
 }
 

Later, you can make any Evernote API calls that you need by obtaining a NoteStore.Client from the session and using the session's auth token:

   NoteStore.client noteStore = session.createNoteStoreClient();
   Notebook notebook = noteStore.getDefaultNotebook(session.getAuthToken());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EvernoteSession.Builder Builder class to construct an EvernoteSession.
static class	EvernoteSession.EvernoteService Evernote Service to use with the bootstrap profile detection.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HOST_CHINA
static java.lang.String	HOST_PRODUCTION
static java.lang.String	HOST_SANDBOX
static int	REQUEST_CODE_LOGIN The used request code when you launch authentication process from a Activity.
static java.lang.String	SCREEN_NAME_INTERNATIONAL
static java.lang.String	SCREEN_NAME_YXBIJI

Method Summary

Modifier and Type	Method and Description
EvernoteSession	asSingleton() Sets this session instance as singleton.
void	authenticate(FragmentActivity activity) Recommended approach to authenticate the user.
void	authenticate(FragmentActivity activity, EvernoteLoginFragment fragment)
android.content.Context	getApplicationContext()
AuthenticationResult	getAuthenticationResult() Get the authentication information returned by a successful OAuth authentication to the Evernote web service.
java.lang.String	getAuthToken() Get the authentication token that is used to make API calls though a NoteStore.Client.
EvernoteClientFactory	getEvernoteClientFactory() Returns a factory to create various clients and helper objects to get access to the Evernote API.
protected EvernoteSession.EvernoteService	getEvernoteService()
static EvernoteSession	getInstance()
boolean	isLoggedIn() Check whether the session has valid authentication information that will allow successful API calls to be made.
boolean	logOut() Clears all stored session information.
protected void	setAuthenticationResult(AuthenticationResult authenticationResult)
void	setEvernoteClientFactoryBuilder(EvernoteClientFactory.Builder builder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HOST_SANDBOX

public static final java.lang.String HOST_SANDBOX

See Also:

Constant Field Values

HOST_PRODUCTION

public static final java.lang.String HOST_PRODUCTION

See Also:

Constant Field Values

HOST_CHINA

public static final java.lang.String HOST_CHINA

See Also:

Constant Field Values

SCREEN_NAME_YXBIJI

public static final java.lang.String SCREEN_NAME_YXBIJI

See Also:

Constant Field Values

SCREEN_NAME_INTERNATIONAL

public static final java.lang.String SCREEN_NAME_INTERNATIONAL

See Also:

Constant Field Values

REQUEST_CODE_LOGIN

public static final int REQUEST_CODE_LOGIN

The used request code when you launch authentication process from a Activity. Override Activity.onActivityResult(int, int, Intent) to receive the result.

See Also:

Constant Field Values

Method Detail

getInstance

public static EvernoteSession getInstance()

getEvernoteService

protected EvernoteSession.EvernoteService getEvernoteService()

Returns:

the Bootstrap object to check for server host urls

getEvernoteClientFactory

public EvernoteClientFactory getEvernoteClientFactory()

Returns a factory to create various clients and helper objects to get access to the Evernote API.

The returned factory is not thread safe itself, however, the cached factory is a thread local object. That means a new factory is created for each thread calling this method. The recommended approach is to reuse worker threads to keep the number of created factories small.

With setEvernoteClientFactoryBuilder(EvernoteClientFactory.Builder) you can exchange the builder.

Returns:

A factory for this thread.

setEvernoteClientFactoryBuilder

public void setEvernoteClientFactoryBuilder(EvernoteClientFactory.Builder builder)

Parameters:

builder - The new builder returning EvernoteClientFactorys in getEvernoteClientFactory().

getApplicationContext

public android.content.Context getApplicationContext()

Returns:

The application context for the running app.

getAuthToken

public java.lang.String getAuthToken()

Get the authentication token that is used to make API calls though a NoteStore.Client.

Returns:

the authentication token, or null if isLoggedIn() is false.

getAuthenticationResult

public AuthenticationResult getAuthenticationResult()

Get the authentication information returned by a successful OAuth authentication to the Evernote web service.

authenticate

public void authenticate(FragmentActivity activity)

Recommended approach to authenticate the user. If the main Evernote app is installed and up to date, the app is launched and authenticates the user. Otherwise the old OAuth process is launched and the user needs to enter his credentials.

Your FragmentActivity should implement EvernoteLoginFragment.ResultCallback to receive the authentication result. Alternatively you can extend EvernoteLoginFragment and override EvernoteLoginFragment.onLoginFinished(boolean).

Parameters:

activity - The FragmentActivity holding the progress dialog.

authenticate

public void authenticate(FragmentActivity activity,
                         EvernoteLoginFragment fragment)

See Also:

authenticate(FragmentActivity)

asSingleton

public EvernoteSession asSingleton()

Sets this session instance as singleton. After that you can use getInstance() to get this session.

Returns:

The same instance.

setAuthenticationResult

protected void setAuthenticationResult(AuthenticationResult authenticationResult)

isLoggedIn

public boolean isLoggedIn()

Check whether the session has valid authentication information that will allow successful API calls to be made.

logOut

public boolean logOut()

Clears all stored session information. If the user is not logged in, then this is a no-op.

Returns:

true if the user successfully logged out, false if the user wasn't logged in.

See Also:

isLoggedIn()