Skip to content

appstud/Azot-android

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

Azot

Platform Maven Facebook

Azot is a mobile analysis SDK that runs directly inside phones or tablets. This repository holds the framework for the android version of Azot written in Java.

Features

  • Gesture analysis
  • Embed feedback
  • Crashs analysis
  • Sessions analysis
  • Heatmaps

##Supported OS & SDK Versions

  • Supported build target - android 23
  • Earliest supported deployment target - android 18
  • Earliest compatible deployment target - android 16

NOTE: 'Supported' means that the library has been tested with this version. 'Compatible' means that the library should work on this OS version (i.e. it doesn't rely on any unavailable SDK features) but is no longer being tested for compatibility.

##Thread Safety

Azot uses threading internally to avoid blocking the UI, but none of the Azot external interfaces are thread safe and you should not call any methods on Azot except from the main thread.

##Installation

Repository URL:

 maven {url 'http://artifactory.toulouse.appstud.me/artifactory/azot-android'}

Maven

<dependency>
  <groupId>io.azot.sdk.android</groupId>
  <artifactId>azot</artifactId>
  <version>1.0</version>
  <type>aar</type>
</dependency>

Gradle

compile('io.azot.sdk.android:azot:1.0@aar')

Ivy

 <dependency org="io.azot.sdk.android" name="azot" rev="1.0">
    <artifact name="azot" ext="aar"/>
</dependency>

Sbt

libraryDependencies += "io.azot.sdk.android" % "azot" % "1.0"

Or

Install Azot manually into your app by dragging the Azot.aar file into your project. You can download it from here

##Start

Add the following code to the onCreate function of your Application class :

Azot.start(this, "AZOT_APP_TOKEN");

NOTE: To get your "AZOT_APP_TOKEN", register here and create an app.

##Important notes

The SDK does not generate videos on simulator.

##Methods

####start:

public static void start(@NonNull Context context, @NonNull String apiKey)

Start analysis in the app with video and medium confidentiality level. Call it in your app delegate. It is the only mandatory function that has to be used.

####event:

public static void event(String tag)

Track events you care about in your app.

####feedback:

public static void feedback(String feedback, String category)

This function is used to collect user feedbacks. The feedbacks will be saved in the session report. It is the one used in our feedback feature.

####Log:

public static LogExternal log()

This function prints and saves your logs, simply use Azot.log() instead of Log function.

##Configuration

You can acces sdk parameters through your dashboard on https://board.azot.io

###General Parameters


####Use feedback Activate or desactivate the "shake for feedback" functionality. (Activated by default)

####Session recording Activate or desactivate session recording. (Activated by default)

####Location recording Activate or desactivate location tracking. (Activated by default)

####Record on debug mode If activated only session from apps downloaded through the Appstore will be retrieved. (Activated by default)

####Only upload on wifi If activated datas will only be sent when the user is connected to wifi. (Desactivated by default)

####Use auto pages tracking If activated pages will be automatically tracked. (Activated by default)

####Use date range Allows you to set a date range in which the SDK will be on. (Desactivated by default)

###Video Parameters


####Video recording Activate or desactivate the video. (Desactivated by default)

####Only upload on wifi If activated videos will only be sent when the user is connected to wifi. (Activated by default)

####Confidentiality Set the video confidentiality level. (MEDIUM by default)

####Use date range Allows you to set a date range in which the Video will be on. (Desactivated by default)

###Feedback Parameters


####Use feedback Activate or Desactivate the "Shake for feedback" gesture. (Activated by default)

####Question for your users Define the question you want us to ask your users on the top of the feedback page.

####Categories Define different feedback categories. (Max. 5)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published