Urban Airship Android Gimbal Adapter

The Urban Airship Gimbal Adapter is a drop-in class that allows users to integrate Gimbal Place events with Urban Airship.

Resources

• Gimbal Developer Guide
• Gimbal Manager Portal
• Urban Airship Getting Started guide

Installation

To install it add the following dependency to your application's build.gradle file:

   implementation 'com.urbanairship.android:gimbal-adapter:3.0.0'

Starting the adapter

To start the adapter call:

   GimbalAdapter.shared(context).start("## PLACE YOUR API KEY HERE ##");

Once the adapter is started, it will automatically resume its last state if the application is restarted in the background. You only need to call start once.

Android Marshmallow Permissions

Before the adapter is able to be started on Android M, it must request the location permission ACCESS_FINE_LOCATION. The adapter has convenience methods that you can use to request permissions while starting the adapter:

    GimbalAdapter.shared(context).startWithPermissionPrompt("## PLACE YOUR API KEY HERE ##", new GimbalAdapter.PermissionResultCallback() {
        @Override
        public void onResult(boolean enabled) {
            if (enabled) {
                // permission granted and adapter started
            }
        }
    });

Alternatively you can follow requesting runtime permissions to manually request the proper permissions. Then once the permissions are granted, call start on the adapter.

Stopping the adapter

Adapter can be stopped at anytime by calling:

   GimbalAdapter.shared(context).stop();