Connect Android SDK

This repository contains code for the Zendesk Connect Android SDK.

It's written in Java, XML, and Kotlin. It uses the Gradle build system.

Documentation

The developer documentation can be found here.

The Javadoc can be found here.

Dependencies

Structure

This repo has a number of modules:

• ConnectSDK - provides an API for interacting with the Connect back-end
• NetworkClient - networking client used to send requests. Generated by our code generation tool Tribble
• ConnectSampleApp - sample application to act as the host app for testing the SDK during development

Getting Started

Prerequisites

You'll need Android Studio and a JDK installed on your machine.

Environment setup

To be able to run the sample application, you are required to provide a Connect private API key. Create or update your ~/.gradle/gradle.properties to include the following:

• CONNECT_PRIVATE_KEY=<your-private-key>

Testing

Please run all tests before opening a pull request. This can be done by running ./gradlew test.

Contribute

Please see our CONTRIBUTING.md file for details on how to contribute.