Skip navigation links
A B C D E G H I L O P R S T V 

A

addListener(BeaconEventListener) - Method in class com.gimbal.android.BeaconManager
 
addListener(CommunicationListener) - Method in class com.gimbal.android.CommunicationManager
Adds a CommunicationListener for notification of Communications.
addListener(PlaceEventListener) - Method in class com.gimbal.android.PlaceManager
 
Attributes - Interface in com.gimbal.android
 

B

Beacon - Class in com.gimbal.android
 
Beacon() - Constructor for class com.gimbal.android.Beacon
 
Beacon.BatteryLevel - Enum in com.gimbal.android
 
BeaconEventListener - Class in com.gimbal.android
 
BeaconEventListener() - Constructor for class com.gimbal.android.BeaconEventListener
 
BeaconManager - Class in com.gimbal.android
 
BeaconManager() - Constructor for class com.gimbal.android.BeaconManager
 
BeaconSighting - Class in com.gimbal.android
 
BeaconSighting() - Constructor for class com.gimbal.android.BeaconSighting
 

C

Circle - Class in com.gimbal.android
 
Circle() - Constructor for class com.gimbal.android.Circle
 
com.gimbal.android - package com.gimbal.android
 
Communication - Class in com.gimbal.android
 
Communication() - Constructor for class com.gimbal.android.Communication
 
CommunicationListener - Class in com.gimbal.android
Interface definition for a callback to be invoked when Gimbal Communications arrive.
CommunicationListener() - Constructor for class com.gimbal.android.CommunicationListener
 
CommunicationManager - Class in com.gimbal.android
Defines the interface for delivering Gimbal Communications to your Gimbal SDK enabled app.
Coordinate - Class in com.gimbal.android
 
Coordinate() - Constructor for class com.gimbal.android.Coordinate
 
currentVisits() - Method in class com.gimbal.android.PlaceManager
 

D

DeviceAttributesManager - Class in com.gimbal.android
 
DeviceAttributesManager() - Constructor for class com.gimbal.android.DeviceAttributesManager
 
disableBeaconSightingsLogging() - Static method in class com.gimbal.android.GimbalDebugger
Disables beacon sighting logs.
disablePlaceLogging() - Static method in class com.gimbal.android.GimbalDebugger
Disables place logs.
disableStatusLogging() - Static method in class com.gimbal.android.GimbalDebugger
Disables status logs.

E

enableBeaconSightingsLogging() - Static method in class com.gimbal.android.GimbalDebugger
Enables beacon sighting logs.
enablePlaceLogging() - Static method in class com.gimbal.android.GimbalDebugger
Enables place event (arrival departure) logs.
enablePushMessaging(boolean) - Method in class com.gimbal.android.CommunicationManager
Enables or disables Gimbal SDK's internal FirebaseMessagingService for handling of push messaging for the application instance.
enablePushMessaging(boolean) - Static method in class com.gimbal.android.Gimbal
Deprecated.
use CommunicationManager.enablePushMessaging() instead
enableStatausLogging() - Static method in class com.gimbal.android.GimbalDebugger
Deprecated.
Use GimbalDebugger.enableStatusLogging() instead
enableStatusLogging() - Static method in class com.gimbal.android.GimbalDebugger
Enables status logs.
equals(Object) - Method in class com.gimbal.android.Beacon
 
equals(Object) - Method in class com.gimbal.android.BeaconSighting
 
equals(Object) - Method in class com.gimbal.android.Communication
 
equals(Object) - Method in class com.gimbal.android.Place
 
equals(Object) - Method in class com.gimbal.android.Push
 
equals(Object) - Method in class com.gimbal.android.Visit
 
EstablishedLocation - Class in com.gimbal.android
This class represents a location commonly visited by the user and is ranked by a score value.
EstablishedLocation() - Constructor for class com.gimbal.android.EstablishedLocation
 
EstablishedLocationsManager - Class in com.gimbal.android
 

G

getAllKeys() - Method in interface com.gimbal.android.Attributes
 
getApplicationInstanceIdentifier() - Static method in class com.gimbal.android.Gimbal
Returns the instance identifier Stringfor a specific client installation of the Android SDK
getArrivalTimeInMillis() - Method in class com.gimbal.android.Visit
 
getAttributes() - Method in class com.gimbal.android.Communication
 
getAttributes() - Method in class com.gimbal.android.Place
 
getBatteryLevel() - Method in class com.gimbal.android.Beacon
 
getBeacon() - Method in class com.gimbal.android.BeaconSighting
 
getBoundary() - Method in class com.gimbal.android.EstablishedLocation
Returns the boundary of the EstablishedLocation.
getCenter() - Method in class com.gimbal.android.Circle
 
getDeliveryDate() - Method in class com.gimbal.android.Communication
 
getDepartureTimeInMillis() - Method in class com.gimbal.android.Visit
 
getDescription() - Method in class com.gimbal.android.Communication
 
getDeviceAttributes() - Method in class com.gimbal.android.DeviceAttributesManager
 
getDwellTimeInMillis() - Method in class com.gimbal.android.Visit
 
getEstablishedLocations() - Method in class com.gimbal.android.EstablishedLocationsManager
 
getExpiryTimeInMillis() - Method in class com.gimbal.android.Communication
 
getGdprConsentRequirement() - Method in class com.gimbal.android.PrivacyManager
Returns whether the user must give consent to the Gimbal SDK to process location information in accordance with the GDPR.
getIconURL() - Method in class com.gimbal.android.Beacon
 
getIdentifier() - Method in class com.gimbal.android.Beacon
 
getIdentifier() - Method in class com.gimbal.android.Communication
 
getIdentifier() - Method in class com.gimbal.android.Place
 
getInstance() - Static method in class com.gimbal.android.CommunicationManager
Returns an instance of CommunicationManager
getInstance() - Static method in class com.gimbal.android.DeviceAttributesManager
 
getInstance() - Static method in class com.gimbal.android.EstablishedLocationsManager
 
getInstance() - Static method in class com.gimbal.android.PlaceManager
 
getInstance() - Static method in class com.gimbal.android.PrivacyManager
Returns the global PrivacyManager instance
getLatitude() - Method in class com.gimbal.android.Coordinate
 
getLongitude() - Method in class com.gimbal.android.Coordinate
 
getName() - Method in class com.gimbal.android.Beacon
 
getName() - Method in class com.gimbal.android.Place
 
getNotificationChannelId() - Method in class com.gimbal.android.CommunicationManager
Returns the identifier of the NotificationChannel to be used by Communication notifications.
getPlace() - Method in class com.gimbal.android.Visit
 
getPushType() - Method in class com.gimbal.android.Push
 
getRadius() - Method in class com.gimbal.android.Circle
 
getRSSI() - Method in class com.gimbal.android.BeaconSighting
 
getScore() - Method in class com.gimbal.android.EstablishedLocation
Returns the score of the EstablishedLocation.
getTemperature() - Method in class com.gimbal.android.Beacon
Temperature of transmitter in fahrenheit.
getTimeInMillis() - Method in class com.gimbal.android.BeaconSighting
 
getTitle() - Method in class com.gimbal.android.Communication
 
getURL() - Method in class com.gimbal.android.Communication
 
getUserConsent(PrivacyManager.ConsentType) - Method in class com.gimbal.android.PrivacyManager
Returns the user's current consent value for the specified feature type.
getUuid() - Method in class com.gimbal.android.Beacon
 
getValue(String) - Method in interface com.gimbal.android.Attributes
 
getVisitID() - Method in class com.gimbal.android.Visit
 
Gimbal - Class in com.gimbal.android
 
GimbalAPIKeyMissingException - Exception in com.gimbal.android
Gimbal.setAPIKey() must be called at least once before any other Gimbal methods are called, including Gimbal.start(), PlaceManager.addListener(), etc.
GimbalAPIKeyMissingException(String) - Constructor for exception com.gimbal.android.GimbalAPIKeyMissingException
 
GimbalDebugger - Class in com.gimbal.android
This class exposes APIs to debug Gimbal SDK.
GimbalDebugger() - Constructor for class com.gimbal.android.GimbalDebugger
 

H

handleMessageReceived(RemoteMessage, Context) - Method in class com.gimbal.android.CommunicationManager
Forwards a message from the app's implementation of FirebaseMessagingService.onMessageReceived() to the Gimbal SDK for processing of Communications.
handleNewToken(String) - Method in class com.gimbal.android.CommunicationManager
Forwards a push token from the app's implementation of FirebaseMessagingService.onTokenReceived() to the Gimbal SDK

I

isBeaconSightingsLoggingEnabled() - Static method in class com.gimbal.android.GimbalDebugger
Gets current state of logging beacon sightings.
isMonitoring() - Method in class com.gimbal.android.EstablishedLocationsManager
 
isMonitoring() - Method in class com.gimbal.android.PlaceManager
 
isPlaceLoggingEnabled() - Static method in class com.gimbal.android.GimbalDebugger
Gets current state of logging places.
isReceivingCommunications() - Method in class com.gimbal.android.CommunicationManager
Returns whether the CommunicationManager has been enabled
isStarted() - Static method in class com.gimbal.android.Gimbal
Returns true if the PlaceManager, CommunicationManager and EstablishedLocationsManager are all started
isStatusLoggingEnabled() - Static method in class com.gimbal.android.GimbalDebugger
Gets current state of logging status.

L

locationDetected(Location) - Method in class com.gimbal.android.PlaceEventListener
 

O

onBeaconSighting(BeaconSighting) - Method in class com.gimbal.android.BeaconEventListener
 
onBeaconSighting(BeaconSighting, List<Visit>) - Method in class com.gimbal.android.PlaceEventListener
 
onNotificationClicked(List<Communication>) - Method in class com.gimbal.android.CommunicationListener
Called when a user clicks on a Gimbal Notification in the notification tray
onVisitEnd(Visit) - Method in class com.gimbal.android.PlaceEventListener
 
onVisitStart(Visit) - Method in class com.gimbal.android.PlaceEventListener
 
onVisitStartWithDelay(Visit, int) - Method in class com.gimbal.android.PlaceEventListener
 

P

Place - Class in com.gimbal.android
 
Place() - Constructor for class com.gimbal.android.Place
 
PlaceEventListener - Class in com.gimbal.android
 
PlaceEventListener() - Constructor for class com.gimbal.android.PlaceEventListener
 
PlaceManager - Class in com.gimbal.android
 
prepareCommunicationForDisplay(Communication, Visit, int) - Method in class com.gimbal.android.CommunicationListener
Called when a Place Arrival results in a Gimbal Communication retrieved from the Gimbal Manager AND communication is returned by presentNotificationForCommunications().
prepareCommunicationForDisplay(Communication, Push, int) - Method in class com.gimbal.android.CommunicationListener
Called when an Instant or Time Triggered Communication is received from Gimbal Manager AND a communication is returned by the presentNotificationForCommunications().
presentNotificationForCommunications(Collection<Communication>, Visit) - Method in class com.gimbal.android.CommunicationListener
Called when a Place Arrival results in Gimbal Communications retrieved from Gimbal Manager.
presentNotificationForCommunications(Collection<Communication>, Push) - Method in class com.gimbal.android.CommunicationListener
Called when Gimbal Manager pushes an Instant or Time Triggered Communication to this listener.
PrivacyManager - Class in com.gimbal.android
Provides methods for managing a user's privacy, e.g. consent requirement(s) and opt-ins for protected features and functionality
PrivacyManager.ConsentState - Enum in com.gimbal.android
Indicates the consent chosen by the user
PrivacyManager.ConsentType - Enum in com.gimbal.android
The Gimbal SDK feature that may be consented to
PrivacyManager.GdprConsentRequirement - Enum in com.gimbal.android
Indicates the requirement for user consent for SDK operation under the GDPR
Push - Class in com.gimbal.android
 
Push() - Constructor for class com.gimbal.android.Push
 
Push.PushType - Enum in com.gimbal.android
 

R

removeListener(BeaconEventListener) - Method in class com.gimbal.android.BeaconManager
 
removeListener(CommunicationListener) - Method in class com.gimbal.android.CommunicationManager
Unregisters the specified CommunicationListener so that it will not receive Communications
removeListener(PlaceEventListener) - Method in class com.gimbal.android.PlaceManager
 
resetApplicationInstanceIdentifier() - Static method in class com.gimbal.android.Gimbal
Resets the Application Instance Identifier for this SDK instance.

S

setApiKey(Application, String) - Static method in class com.gimbal.android.Gimbal
Links an instance of an Android app with a Gimbal Manager application.
setApiKeyWithOptions(Application, String, Map<String, String>) - Static method in class com.gimbal.android.Gimbal
 
setDeviceAttributes(Map<String, String>) - Method in class com.gimbal.android.DeviceAttributesManager
 
setNotificationChannelId(String) - Method in class com.gimbal.android.CommunicationManager
Specifies a NotificationChannel to be used by Communication notifications.
setUserConsent(PrivacyManager.ConsentType, PrivacyManager.ConsentState) - Method in class com.gimbal.android.PrivacyManager
Informs the SDK of the user's consent for the specified feature type
start() - Static method in class com.gimbal.android.Gimbal
Starts all Gimbal SDK services.
startListening() - Method in class com.gimbal.android.BeaconManager
 
startMonitoring() - Method in class com.gimbal.android.EstablishedLocationsManager
 
startMonitoring() - Method in class com.gimbal.android.PlaceManager
 
startReceivingCommunications() - Method in class com.gimbal.android.CommunicationManager
Enables the CommunicationManager to receive Gimbal Communications from Gimbal Manager and deliver them to end users
stop() - Static method in class com.gimbal.android.Gimbal
Stops all Gimbal services.
stopListening() - Method in class com.gimbal.android.BeaconManager
 
stopMonitoring() - Method in class com.gimbal.android.EstablishedLocationsManager
 
stopMonitoring() - Method in class com.gimbal.android.PlaceManager
 
stopReceivingCommunications() - Method in class com.gimbal.android.CommunicationManager
Stops all communication delivery.

T

toString() - Method in class com.gimbal.android.Beacon
 
toString() - Method in class com.gimbal.android.BeaconSighting
 
toString() - Method in class com.gimbal.android.Communication
 
toString() - Method in class com.gimbal.android.EstablishedLocation
 
toString() - Method in class com.gimbal.android.Place
 
toString() - Method in class com.gimbal.android.Push
 
toString() - Method in class com.gimbal.android.Visit
 

V

valueOf(String) - Static method in enum com.gimbal.android.Beacon.BatteryLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gimbal.android.PrivacyManager.ConsentState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gimbal.android.PrivacyManager.ConsentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gimbal.android.PrivacyManager.GdprConsentRequirement
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.gimbal.android.Push.PushType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.gimbal.android.Beacon.BatteryLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gimbal.android.PrivacyManager.ConsentState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gimbal.android.PrivacyManager.ConsentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gimbal.android.PrivacyManager.GdprConsentRequirement
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.gimbal.android.Push.PushType
Returns an array containing the constants of this enum type, in the order they are declared.
Visit - Class in com.gimbal.android
 
Visit() - Constructor for class com.gimbal.android.Visit
 
A B C D E G H I L O P R S T V 
Skip navigation links