Android SDK for Salesforce
Latest commit 9234cac Jul 2, 2018

README.md

CircleCI codecov

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.
  • If you'd like to add the SDK to your existing app, the easiest way is to add our libraries as Gradle dependencies from our Maven repo here.

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 6.2

Library Upgrades

  • We've updated React Native to version 0.55.4.

Tool Version Upgrades

  • We now require Cordova CLI 8.0.0.
  • We now support Android Studio 3.1 and Gradle 4.4.

SmartSync Data Framework Enhancements

  • The SmartSync Data Framework now saves the error returned when records fail to sync up.
  • A new utility, MetadataSyncManager, harnesses the power of SmartSync Data Framework to query Salesforce object metadata.
  • Another new utility, LayoutSyncManager, harnesses the power of SmartSync Data Framework to query Salesforce object layouts.

Other Technical Improvements

  • We've replaced IntentService with JobService. This change helps optimize the execution of background tasks, especially on newer Android versions.
  • We’ve given the Switch User screen a face lift.
  • We've consolidated our templates under a single repository.
  • Improvements to sample apps.
  • Various bug fixes.

Deprecations

  • MetadataManager is now deprecated and will be removed in Mobile SDK 7.0. Instead, use MetadataSyncManager and LayoutSyncManager.
  • CacheManager is now deprecated and will be removed in Mobile SDK 7.0. Offline caching is now automatically handled by the SmartSync Data Framework.
  • SalesforceObjectType is now deprecated and will be removed in Mobile SDK 7.0. Instead, use Metadata.
  • SalesforceObjectTypeLayout and SalesforceObjectLayoutColumn are now deprecated and will be removed in Mobile SDK 7.0. Instead, use Layout.

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.

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 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.