Version: Alpha-1
Released: 1 September 2014
Important note: this is an early pre-release version, and is subject to change.
The SDK provides a convenient library for accessing the Mendeley API from Android applications.
Android version: API level 14 (Android 4.0, ICS)
Java version: 1.7
A sample app is provided, which illustrates basic use of the library. The app links to the
SDK library via a relative path in its project.properties
file, as usual for Android libraries.
To run the sample app you must change the dummy client ID, client secret and redirect URI constants
defined at the top of ExampleActivity.java
to the correct ones for your own app.
These values can be generated from the Mendeley developers website.
You should start by calling MendeleySdkFactory.getInstance()
to get a
MendeleySdk
object. This contains methods for all the API calls, as well as
isSignedIn()
, signIn()
and signOut()
. The client must call signIn()
before
making API calls, otherwise a NotSignedInException
will be thrown.
Many of the API calls take parameters, which are defined in the com.mendeley.api.params
package.
They return a callback defined in one of the of com.mendeley.api.callbacks.*
subpackages.
The data types returned are defined in the com.mendeley.api.model
package.
On failure, they either invoke the appropriate callback, or raise an exception from the
com.mendeley.api.exceptions
package.
Reference documentation: Javadoc
The main API calls provided by MendeleySdk
methods are as follows (arguments omitted
for brevity):
getDocuments
getDocument
getDeletedDocuments
postDocument
patchDocument
trashDocument
deleteDocument
getDocumentTypes
getFiles
getFile
cancelDownload
postFile
deleteFile
getMyProfile
getProfile
getFolders
getFolder
postFolder
patchFolder
deleteFolder
getFolderDocumentIds
postDocumentToFolder
deleteDocumentFromFolder
getImage
getGroups
getGroup
getGroupMembers
Email: api@mendeley.com