Package com.gimbal.android

Class Gimbal

java.lang.Object

com.gimbal.android.Gimbal

public class Gimbal
extends Object

Method Summary

Modifier and Type	Method	Description
static void	enablePushMessaging(boolean enable)	Deprecated. use CommunicationManager.enablePushMessaging() instead
static String	getApplicationInstanceIdentifier()	Returns the instance identifier Stringfor a specific client installation of the Android SDK
static boolean	isStarted()	Returns true if the PlaceManager, CommunicationManager and EstablishedLocationsManager are all started
static void	resetApplicationInstanceIdentifier()	Resets the Application Instance Identifier for this SDK instance.
static void	setApiKey(android.app.Application application, String apiKey)	Links an instance of an Android app with a Gimbal Manager application.
static void	setApiKeyWithOptions(android.app.Application application, String apiKey, Map<String,String> options)
static void	start()	Starts all Gimbal SDK services.
static void	stop()	Stops all Gimbal services.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setApiKey

public static void setApiKey(android.app.Application application,
 String apiKey)

Links an instance of an Android app with a Gimbal Manager application. This must be called before any other Gimbal methods are called, e.g. Gimbal.start(), PlaceManager.addListener(), etc., and only needs to be called once for a given application install. Additional calls with the same API key have no effect.

Parameters:

application - the currently running Android Application

apiKey - the API key string copied from the corresponding application in Gimbal Manager

setApiKeyWithOptions

public static void setApiKeyWithOptions(android.app.Application application,
 String apiKey,
 Map<String,String> options)

getApplicationInstanceIdentifier

public static String getApplicationInstanceIdentifier()

Returns the instance identifier Stringfor a specific client installation of the Android SDK

Returns:

this application instance's identifier

enablePushMessaging

public static void enablePushMessaging(boolean enable)

Deprecated.

use CommunicationManager.enablePushMessaging() instead

Enables or disables push messaging for the application instance. This only needs to be called once per app instance. If Gimbal.registerForPush() had been called on an existing app instance with a previous version of the SDK, the V4 SDK will migrate this setting to effectively call enablePushMessaging(true).

In order for push messages to be received, the CommunicationManager will need to be started, and Firebase will need to be configured for the application. See the Developer's Guide for additional information.

Parameters:

enable - true to enable push messaging

Since:

4.0.0

resetApplicationInstanceIdentifier

public static void resetApplicationInstanceIdentifier()

Resets the Application Instance Identifier for this SDK instance. Dissociates a device from its data (e.g. place events) reported by an application instance. The open place sightings get closed on the server. Instance-specific data on device also gets cleared. This call is rarely required.

start

public static void start()

Starts all Gimbal SDK services. This includes the generation of events based on the user's location and proximity to geofences and beacons, the reception of place- and time-based Communications, and the generation of established locations based on the user's movements. This is a shortcut for starting the PlaceManager, CommunicationManager and EstablishedLocationsManager.

stop

public static void stop()

Stops all Gimbal services. This is a shortcut for stopping the PlaceManager, CommunicationManager and EstablishedLocationsManager.

isStarted

public static boolean isStarted()

Returns true if the PlaceManager, CommunicationManager and EstablishedLocationsManager are all started

Returns:

true if all Gimbal services are started