Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
titleUp To Date

Table of Contents

Android Probe API

Installation in your project libraries or in a Maven repository

Download the aar library from the GREENSPECTOR Modules page on the Web Interface and install it:

  • either in the libs folder of your Android project;
  • or in a local or remote Maven repository.

Example for a local Maven repository:

Code Block
languagebash
mvn install:install-file
-Dfile=greenspector-probe-android-[version].aar
-DgroupId=com.greenspector.probe.android
-DartifactId=greenspector-probe-android
-Dversion=[version]
-Dpackaging=aar

Integration in your Android project

If you have installed the library in the libs folder of your Android project

Add the dependency in your project's module build.gradle file:

Code Block
languagejava
titlebuild.gradle
dependencies {
	compile files('libs/greenspector-probe-android-[version].aar')
}

If you have installed the library in a Maven repository

Check your Maven repository is configured inside the project's build.gradle file.

Example for a local Maven repository:

Code Block
languagejava
titlebuild.gradle
repositories {
	mavenLocal()
}

Add the dependency in your project's module build.gradle file:

Code Block
languagejava
titlebuild.gradle
dependencies {
	compile ('com.greenspector.probe.android:greenspector-probe-android:[version]')
}

Android project configuration

In order to be able to correctly use the Probe API you need to add some permissions in your application's AndroidManifest.xml file.

  • Permission to use Internet (to send the results to the GREENSPECTOR Server):
Code Block
titleAndroidManifest.xml
 <uses-permission android:name="android.permission.INTERNET"/>
  • Permissions to read and write on the SD Card (to read and write results files):
Code Block
titleAndroidManifest.xml
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

IMPORTANT

From Android 6.0 (API level 23), some permissions are considered dangerous.
The permissions android.permission.READ_EXTERNAL_STORAGE and android.permission.WRITE_EXTERNAL_STORAGE must be granted explicitly via ADB commands for the measures to run correctly.

First install your application on your mobile, then launch the following commands to grant permissions:

Code Block
languagebash
adb shell pm grant com.example.myapp android.permission.READ_EXTERNAL_STORAGE
adb shell pm grant com.example.myapp android.permission.WRITE_EXTERNAL_STORAGE

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@185bfa9a
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "probeapi" and type = "page" and space = "DOCUMENTATION"
labelskb-how-to-article


Page Properties
hiddentrue


Related issues