Skip to content
JM.PASCAL edited this page Feb 25, 2015 · 2 revisions

##Introduction Alfresco Android SDK project use Maven as build system with Android Maven Plugin.

##History Historically Android SDK contained

  • 3 jar librairies (client-api, async, ui_library)
  • a sample application
  • a sample extension module
  • a sample hellorepo project
  • X tests projects

But regarding the recent Alfresco Android App refactoring in version 1.5, the SDK contains now

  • 1 single jar librairy: client-api
  • a sample extension module
  • a sample hellorepo project
  • X tests projects based on test project

We removed async librairy mostly because there's more than one possibility to do async operations in Android. We didn't want to force Android developer to use our async mechanism but let him use their own internal mechanism.
ui_library has been merged into the foundation module project on Alfresco Android APP project.

##Dependencies client-api library has 3 dependencies

  • chemistry-opencmis-android-client
  • org.slf4j
  • alfresco-opencmis-extension

##Import the SDK into your Android project

####With Jar Files If you have downloaded the Alfresco Android SDK from the Alfresco Developer portal (zip file), you can add the 4 jars files (client api + 3 depedencies) into the libs folder of your Android project.

However even if we offer this ability, we highly recommend to use Gradle/Maven mechanism to manage automatically dependencies and integration into your Android project.

####With Gradle The easiest way to integrate the Alfresco Android SDK is to add a dependency in your build.gradle like

compile 'org.alfresco.mobile.android.sdk:alfresco-mobile-android-client-api:1.4.0'

####With Maven To integrate the SDK into your project you have to edit your pom.xml and add a new dependency like

<dependency>
  <groupId>org.alfresco.mobile.android.sdk</groupId>
  <artifactId>alfresco-mobile-android-client-api</artifactId>
  <version>1.4.0</version>
</dependency>

Build the SDK source code

Prerequisites

  • Java
  • Maven
  • Android SDK
  • Git

Steps

The quickest and easiest way to build the SDK process is the following

  • Checkout the project from Github
  • Open a command prompt inside your project root folder
  • Execute the maven command mvn clean install -DskipTests=true
  • This will generate client_api.jar file

##More Information

Clone this wiki locally