com.evernote.client.android

Class EvernoteSession.Builder

java.lang.Object

com.evernote.client.android.EvernoteSession.Builder

Enclosing class:

EvernoteSession

public static class EvernoteSession.Builder
extends java.lang.Object

Builder class to construct an EvernoteSession.

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
EvernoteSession	build(java.lang.String consumerKey, java.lang.String consumerSecret) Creates a new instance with this consumer key and secret pair.
EvernoteSession	buildForSingleUser(java.lang.String developerToken, java.lang.String noteStoreUrl) Creates a session only for your personal account.
EvernoteSession.Builder	setEvernoteService(EvernoteSession.EvernoteService evernoteService) Default is EvernoteSession.EvernoteService.SANDBOX.
EvernoteSession.Builder	setForceAuthenticationInThirdPartyApp(boolean forceAuthenticationInThirdPartyApp) Default is false.
EvernoteSession.Builder	setLocale(java.util.Locale locale) The parameter is used to find the appropriate Evernote server, which can be with EvernoteSession.EvernoteService.PRODUCTION either EvernoteSession.HOST_PRODUCTION or EvernoteSession.HOST_CHINA.
EvernoteSession.Builder	setSupportAppLinkedNotebooks(boolean supportAppLinkedNotebooks) Default is true.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context)

Parameters:

context - Any context. The session caches the application context.

Method Detail

setEvernoteService

public EvernoteSession.Builder setEvernoteService(EvernoteSession.EvernoteService evernoteService)

Default is EvernoteSession.EvernoteService.SANDBOX. You need to exchange the value for your production app.

Parameters:

evernoteService - The desired service.

Returns:

This Builder object to allow for chaining of calls to set methods.

setSupportAppLinkedNotebooks

public EvernoteSession.Builder setSupportAppLinkedNotebooks(boolean supportAppLinkedNotebooks)

Default is true.

Parameters:

supportAppLinkedNotebooks - true if app linked notebooks are supported.

Returns:

This Builder object to allow for chaining of calls to set methods.

setForceAuthenticationInThirdPartyApp

public EvernoteSession.Builder setForceAuthenticationInThirdPartyApp(boolean forceAuthenticationInThirdPartyApp)

Default is false.

Parameters:

forceAuthenticationInThirdPartyApp - true if the authentication should be launched in the third party app and not in the main Evernote app.

Returns:

This Builder object to allow for chaining of calls to set methods.

setLocale

public EvernoteSession.Builder setLocale(java.util.Locale locale)

The parameter is used to find the appropriate Evernote server, which can be with EvernoteSession.EvernoteService.PRODUCTION either EvernoteSession.HOST_PRODUCTION or EvernoteSession.HOST_CHINA. China is only used if the locale is Chinese, e.g. Locale.SIMPLIFIED_CHINESE.

Usually you don't want change this value. But for testing purposes it makes sense to switch to a Chinese locale and to test that your app works for Chinese users.

The default value is Locale.getDefault().

Parameters:

locale - The new locale used the fetch the bootstrap profiles. null is not allowed.

Returns:

This Builder object to allow for chaining of calls to set methods.

build

public EvernoteSession build(java.lang.String consumerKey,
                             java.lang.String consumerSecret)

Creates a new instance with this consumer key and secret pair.

Parameters:

consumerKey - Your consumer key.

consumerSecret - Your consumer secret.

Returns:

The new created session. Call EvernoteSession.asSingleton() to make reuse the session in the SDK.

buildForSingleUser

public EvernoteSession buildForSingleUser(java.lang.String developerToken,
                                          java.lang.String noteStoreUrl)

Creates a session only for your personal account. Use this with the production environment.

Parameters:

developerToken - Your personal developer token.

noteStoreUrl - The note store url of your Evernote account.

Returns:

The new created session. Call EvernoteSession.asSingleton() to make reuse the session in the SDK.