Android SDK for Salesforce
Java JavaScript Other
Latest commit 8b13749 Jul 12, 2016 @bhariharan bhariharan committed on GitHub Merge pull request #1191 from bhariharan/master
Latest shared
Failed to load latest commit information.
.github Add issue_template May 27, 2016
external Latest shared Jul 12, 2016
gradle/wrapper Latest gradle wrapper (2.12) and android gradle plugin (1.5.0) Apr 4, 2016
hybrid Moving to SQLCipher 3.4 May 4, 2016
libs Bumping up version numbers Jul 8, 2016
native disable the unreliable hybrid test May 31, 2016
node Bumping up version numbers Jul 8, 2016
reactnative/ReactNativeTemplateApp Changes to support 64 bits devices with react native Jun 27, 2016
tools Moving to SQLCipher 3.4 May 4, 2016
.gitignore Add to gitignore and npmignore May 27, 2016
.gitmodules Submodule for white list plugin Apr 26, 2016
.npmignore Add to gitignore and npmignore May 27, 2016
.travis.yml resolve merge conflict Jul 1, 2016
LICENSE.md Updated license file Jul 28, 2015
README.md What's New for 4.2 Jul 7, 2016
UPGRADE.md Updating upgrade doc Jul 7, 2016
build.gradle Merge pull request #1164 from wmathurin/unstable Jun 15, 2016
build_npm.xml Using pre/post publish from shared Aug 3, 2015
gradle.properties Changes to support 64 bits devices with react native Jun 27, 2016
gradlew Latest gradle wrapper (2.12) and android gradle plugin (1.5.0) Apr 4, 2016
gradlew.bat Latest gradle wrapper (2.12) and android gradle plugin (1.5.0) Apr 4, 2016
install.sh Adding react dependencies in install.sh and in package.json for react… Jun 16, 2016
install.vbs Adding react dependencies in install.sh and in package.json for react… Jun 16, 2016
npm.md Updated README and npm target doc Aug 28, 2014
package.json Upgrade to latest shell js May 25, 2016
settings.gradle Some more updates Oct 22, 2015

README.md

Build Status

Salesforce.com Mobile SDK for Android

You have arrived at the source repository for the Salesforce Mobile SDK for Android. Welcome! Starting with our 2.0 release, there are now two ways you can choose to work with the Mobile SDK:

  • If you'd like to work with the source code of the SDK itself, you've come to the right place! You can browse sample app source code and debug down through the layers to get a feel for how everything works under the covers. Read on for instructions on how to get started with the SDK in your development environment.
  • If you're just eager to start developing your own application, the quickest way is to use our npm binary distribution package, called forcedroid, which is hosted on npmjs.org. Getting started is as simple as installing the npm package and launching your template app. You'll find more details on the forcedroid package page.

Installation (do this first - really)

After cloning the SalesforceMobileSDK-Android project from github, run the install script from the command line:

./install.sh

This pulls submodule dependencies from github.

(Windows users: run cscript install.vbs from the command line instead.)

Introduction

What's New in 4.2

SmartStore Enhancements

  • FTS 5 is now supported.
  • We've added a new index type for JSON1.
  • We've added a new API to support deleting soup elements by specifying a query.
  • We've added a new optional parameter to our query APIs, called selectPaths.

SmartSync Enhancements

  • SmartSync now provides a cleanResyncGhosts method for removing ghost records, that is, records that don't match sync criteria or have been deleted from the server.

SalesforceReact Enhancements

  • SalesforceReact now supports deferred authentication.

Library Upgrades

  • The Instant Run feature on Android Studio is now supported.
  • We've replaced Volley with OkHttp for networking.
  • We've updated React Native to version 0.27.2.
  • We've updated SQLCipher to version 3.4.

Other Technical Improvements

  • Improvements to sample apps.
  • Various bug fixes.

Check http://developer.force.com/mobilesdk for additional articles and tutorials.

Native Applications

The Salesforce Mobile SDK provides essential libraries for quickly building native mobile apps that seamlessly integrate with the Salesforce cloud architecture. Out of the box, we provide an implementation of OAuth2, abstracting away the complexity of securely storing refresh tokens or fetching a new session ID when a session expires. The SDK also provides Java wrappers for the Salesforce REST API, making it easy to retrieve, store, and manipulate data.

Hybrid Applications

HTML5 is quickly emerging as dominant technology for developing cross-platform mobile applications. While developers can create sophisticated apps with HTML5 and JavaScript, some limitations remain, specifically: session management, access to the camera and address book, and the inability to distribute apps inside public App Stores. The Salesforce Mobile Container makes possible to combine the ease of web app development with power of the Android platform by wrapping a web app inside a thin native container, producing a hybrid application.

WARNING: OAuth2 token storage on devices without encryption

The Salesforce Mobile SDK provides PIN-based OAuth token encryption for Android devices that don't provide full storage encryption functionality. The SDK implementation is NOT designed to provide complete security. It's simply offered as an option for temporarily protecting your app from eavesdroppers. Please use caution in your production deployment with sensitive data. We strongly recommend deploying production apps on the latest generation of Android devices with build-in device encryption.

Setting up your Development Environment

The following steps will help you get started with your development environment, whether you choose to develop native apps or hybrid apps. See the README files in the native/ and hybrid/ folders for additional notes pertaining to development in those environments.

  1. Install the Android SDK (r23 or above) and Android Studio: http://developer.android.com/sdk/index.html
  2. Get setup on github: http://help.github.com/

Downloading the Salesforce SDK

To pull down the SDK from github, create a new directory and git clone the salesforce SDK repo.

git clone https://github.com/forcedotcom/SalesforceMobileSDK-Android.git

Documentation

Discussion

If you would like to make suggestions, have questions, or encounter any issues, we'd love to hear from you. Post any feedback you have on our Google+ Community.