xambarr / mapbox-events-android

Mapbox telemetry and core libraries for Android.

Mapbox Mobile Events

This repository houses the Mapbox Telemetry and Core Libraries for Android.

About libtelemetry

The Mapbox Telemetry Library for Android is used to collect anonymous and aggregated information about Mapbox usage. We use telemetry from all Mapbox SDKs to improve our map, directions, travel times, and search. We collect anonymous data about how users interact with the map to help developers build better location based applications.

Visit https://www.mapbox.com/telemetry for higher-level information about telemetry and data security at Mapbox

About libcore

The Mapbox Core Library for Android is a set of utilities that help you with permissions, device location, and connectivity within your Android project. You can:

• Check for, request, and respond to any number of Android system permissions such as device location or camera.
• Check for and respond to a change in the device's internet connectivity status.
• Retrieve a device's real-time location.

Getting Started

If you are looking to include the Core Library inside of your project, please take a look at the detailed instructions found in our docs. If you are interested in building from source, read the contributing guide inside of this project.

The snippet to add to your app-level build.gradle file to use is the following:

// Mapbox Core Library for Android

implementation 'com.mapbox.mapboxsdk:mapbox-android-core:0.2.1'

To run the sample code on a device or emulator, include your developer access token in developer-config.xml found in the project.

Documentation

You'll find all of the documentation for the Core Library on our Mapbox Core page. This includes information on installation, using the API, and links to the API reference.

Getting Help

• Need help with your code?: Look for previous questions on the #mapbox tag — or ask a new question.
• Have a bug to report? Open an issue. If possible, include the version of Mapbox Core that you're using, a full log, and a project that shows the issue.
• Have a feature request? Open an issue. Tell us what the feature should do and why you want the feature.

Using Snapshots

If you want to test recent bug fixes or features that have not been packaged in an official release yet, you can use a -SNAPSHOT release of the current development version of the Mapbox Core Library via Gradle, available on Sonatype.

repositories {
    mavenCentral()
    maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
}

dependencies {
    implementation 'com.mapbox.mapboxsdk:mapbox-android-core:X.X.X-SNAPSHOT'
}

Sample code

This repo's test app can help you get started with the Core library and to inspire you.

Contributing

We welcome feedback, translations, and code contributions! Please see CONTRIBUTING.md for details.