Alfresco Mobile SDK for Android

331 Pages·2013·1.38 MB·English

Alfresco Mobile SDK for Android 1.1
Alfresco Mobile SDK for Android
Contents
Introduction................................................................................................................................5
What's new in 1.1?....................................................................................................................6
Requirements.............................................................................................................................7
Where to find the SDK..............................................................................................................8
Binary distribution.....................................................................................................................9
Source distribution..................................................................................................................10
Tutorials....................................................................................................................................11
How to check out the SDK source code from GitHub.......................................................11
Creating a directory to contain the SDK source code...............................................11
Checking out the source code from GitHub..............................................................11
How to build the SDK source code using Maven.............................................................11
How to build and run the SDK Samples application.........................................................11
How to build and run the HelloRepo application...............................................................12
How to use the SDK with Eclipse.....................................................................................14
How to create an application that uses the SDK binary package..............................14
How to import the SDK binary package into your Eclipse workspace.......................19
How to import the SDK Maven projects into your Eclipse workspace.......................24
Extending HelloRepo.........................................................................................................30
Creating a new project..............................................................................................30
Link the application to the SDK.................................................................................31
Add the basic code....................................................................................................31
Adding a node adapter class....................................................................................34
Adding a message object class.................................................................................36
Creating the NodeDetailActivity.................................................................................38
Creating the NodeDetailActivity user interface..........................................................39
Adding code to the NodeDetailActivity class.............................................................41
Modify the main activity code....................................................................................43
Test your application.................................................................................................46
Adding support for Tags............................................................................................47
Working with sites.............................................................................................................54
The basics of working with sites...............................................................................54
Joining and leaving sites...........................................................................................58
Adding a GUI.............................................................................................................65
Extending the GUI.....................................................................................................75
API Reference..........................................................................................................................84
Asynchronous API.............................................................................................................84
Classes Overview......................................................................................................84
AbstractBaseLoader...................................................................................................85
AbstractPagingLoader................................................................................................87
ActivityStreamLoader.................................................................................................88
CommentCreateLoader..............................................................................................90
2 Alfresco Mobile SDK for Android 1.1
CommentsLoader.......................................................................................................91
DocumentCreateLoader.............................................................................................92
DownloadTask............................................................................................................94
FolderCreateLoader...................................................................................................97
IsLikedLoader.............................................................................................................98
LikeLoader..................................................................................................................99
LoaderResult............................................................................................................100
NodeChildrenLoader................................................................................................102
NodeDeleteLoader...................................................................................................104
NodeUpdateLoader..................................................................................................105
RepositoryInfoLoader...............................................................................................106
SearchLoader...........................................................................................................107
SessionLoader.........................................................................................................108
SitesLoader..............................................................................................................110
TagsLoader..............................................................................................................112
VersionsLoader........................................................................................................113
Client API.........................................................................................................................114
Classes Overview....................................................................................................114
Sorting......................................................................................................................117
Error Codes..............................................................................................................118
Determining SDK Version........................................................................................120
org.alfresco.mobile.android.api.session...................................................................121
org.alfresco.mobile.android.api.session.authentication............................................142
org.alfresco.mobile.android.api.services..................................................................147
org.alfresco.mobile.android.api.model.....................................................................191
org.alfresco.mobile.android.api.exceptions..............................................................273
UI Library API..................................................................................................................279
Classes Overview....................................................................................................279
org.alfresco.mobile.android.intent............................................................................281
org.alfresco.mobile.android.ui.activitystream...........................................................282
org.alfresco.mobile.android.ui.comment..................................................................283
org.alfresco.mobile.android.ui.comment.actions......................................................285
org.alfresco.mobile.android.ui.comment.listener......................................................286
org.alfresco.mobile.android.ui.documentfolder........................................................287
org.alfresco.mobile.android.ui.documentfolder.actions............................................290
org.alfresco.mobile.android.ui.documentfolder.listener............................................296
org.alfresco.mobile.android.ui.filebrowser................................................................298
org.alfresco.mobile.android.ui.fragments.................................................................301
org.alfresco.mobile.android.ui.manager...................................................................306
org.alfresco.mobile.android.ui.properties.................................................................317
org.alfresco.mobile.android.ui.search......................................................................318
org.alfresco.mobile.android.ui.site............................................................................319
org.alfresco.mobile.android.ui.tag............................................................................321
Alfresco Mobile SDK for Android 3
org.alfresco.mobile.android.ui.tag.actions................................................................324
org.alfresco.mobile.android.ui.utils...........................................................................325
org.alfresco.mobile.android.ui.version......................................................................329
4 Alfresco Mobile SDK for Android 1.1
Introduction
Introduction
This section provides an introduction to the Android version of the Alfresco Mobile SDK.
The Alfresco Mobile SDK includes a set of APIs and samples that provides a facility for partners,
customers and developers to develop applications that access Alfresco server functionality. Both
on-premise and Cloud-based servers are supported, with support been included for servers from
3.4.x and above. This documentation describes the SDK targeted at the Android platform.
This SDK comprises the following:
1. Client API
2. SDK Samples application
3. Asynchronous library
4. User Interface library
5. Sample extension
6. HelloRepo example
The Client API provides a library that allows a developer to quickly incorporate the ability to
access Alfresco and CMIS-compliant servers to their application.
The SDK Samples application provides an extensive example application that demonstrates how
to use the Client API.
The Asynchronous library provides a set of loaders to allow asynchronous access to Alfresco
services.
The User Interface library provides a collection of frequently used user interface fragments for the
convenience of the developer.
The Sample extension demonstrates how to extend the SDK.
The HelloRepo application is a very minimal example demonstrating the basics of connecting to
an Alfresco repository.
Alfresco Mobile SDK for Android 5
What's new in 1.1?
What's new in 1.1?
This section describes the new features of the 1.1 SDK.
• API calls have been added to allow a user to join or leave a site, and add a site to their
favorites, and remove a site from their favorites.
• Improved cache management through use of a method to clear cached session data.
• Additional error codes.
• API calls have been added to allow for easier creation of custom types.
6 Alfresco Mobile SDK for Android 1.1
Requirements
Requirements
This section describes prerequisites that are required in order to use the SDK.
• Android OS version 3.0 (Honeycomb) and above is required to run applications built with
the SDK.
• The Android Developer's kit (ADK) is required to build applications that use the SDK. You
can download the latest ADK from the Android Developer's site. It is recommended that
you use the latest version of the ADK.
• Java 1.5+ is required to build the SDK from source code. You can download it from the
Oracle download site To check your installed version, open a command prompt and type:
java -version.
• Maven 3.0.1+ is required to build SDK from source code. You can download it from the
Maven download site You can configure Maven using instructions on the Maven website.
To check your installed version, open a command prompt and type: mvn -version.
• You will require a GitHub account and git available from the command line. Git is used to
check out source code from the Alfresco GitHub repository.
Alfresco Mobile SDK for Android 7
Where to find the SDK
Where to find the SDK
This section describes how to obtain the binary and source distributions of the SDK.
Binary distributions
The binary distribution of the Alfresco Mobile SDK can be found at the Alfresco Developer's
Portal.
Source code distributions
GitHub is used to distribute the source code for the Alfresco Mobile SDK.
The Alfresco Mobile SDK for Android is located on GitHub. The location for all Alfresco GitHub
distributions is https://github.com/Alfresco.
The Alfresco Mobile SDK for Android GitHub page can be found at the following URL https://
github.com/Alfresco/alfresco-android-sdk.
8 Alfresco Mobile SDK for Android 1.1
Binary distribution
Binary distribution
This topic describes the packaging of the binary distribution.
The binary distribution consists of Zip file, alfresco-android-sdk-1.1.x.zip that contains a
collection of JAR files in the libs folder. x represents the revision number.
It also contains a directory structure and additional files to allow the SDK to be imported into an
Eclipse workspace. This is discussed in the following How to import the SDK binary package into
your Eclipse workspace on page 19.
Alfresco Mobile SDK for Android 9
Source distribution
Source distribution
This topic describes the structure of the source code distribution.
The source code for the Alfresco Android Mobile SDK, which can be checked out of the GitHub
repository, is a Maven-based release which consists of the following modules:
• alfresco-mobile-android-async
• alfresco-mobile-android-client-api
• alfresco-mobile-android-ui-library
• samples/alfresco-mobile-android-samples-app
• samples/alfresco-mobile-android-samples-extension
• samples/alfresco-mobile-android-samples-hellorepo
alfresco-mobile-android-async
Android uses a loader system to load asynchronous tasks. This library provides a collection of
asynchronous loaders.
alfresco-mobile-android-client-api
This project defines the Client API.
alfresco-mobile-android-ui-library
UI library consists of various UI fragments that can be used in your application. This saves
time when creating your own user interfaces.
samples/alfresco-mobile-android-samples-app
Small, self-contained code samples, that illustrate how to use the Client API.
samples/alfresco-mobile-android-samples-extension
A sample showing how to extend the SDK.
samples/alfresco-mobile-android-samples-hellorepo
A very simple example demonstrating how to connect to a repository.
10 Alfresco Mobile SDK for Android 1.1