Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ABORTED - Enum constant in enum class com.gimbal.android.PickupManager.PickupCompletionReason
- addListener(BeaconEventListener) - Method in class com.gimbal.android.BeaconManager
- addListener(CommunicationListener) - Method in class com.gimbal.android.CommunicationManager
-
Adds a
CommunicationListener
for notification ofCommunication
s. - addListener(PlaceEventListener) - Method in class com.gimbal.android.PlaceManager
- addListener(LocationCallback) - Method in class com.gimbal.android.ForegroundLocationService.ForegroundLocationBinder
- AnalyticsManager - Class in com.gimbal.android
- AnalyticsManager() - Constructor for class com.gimbal.android.AnalyticsManager
- ARRIVAL_CONFIRMED - Enum constant in enum class com.gimbal.android.Pickup.State
- ARRIVED - Enum constant in enum class com.gimbal.android.Pickup.State
- attribute(String, String) - Method in class com.gimbal.android.PickupRequest.Builder
- attributes(Map<String, String>) - Method in class com.gimbal.android.Pickup.PickupBuilder
- attributes(Map<String, String>) - Method in class com.gimbal.android.PickupRequest.Builder
- Attributes - Interface in com.gimbal.android
- AWAITING - Enum constant in enum class com.gimbal.android.Pickup.State
B
- Beacon - Class in com.gimbal.android
- Beacon() - Constructor for class com.gimbal.android.Beacon
- Beacon.BatteryLevel - Enum Class 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
- build() - Method in class com.gimbal.android.Pickup.PickupBuilder
- build() - Method in class com.gimbal.android.PickupRequest.Builder
- builder() - Static method in class com.gimbal.android.PickupRequest
- Builder() - Constructor for class com.gimbal.android.PickupRequest.Builder
C
- CANCELLED - Enum constant in enum class com.gimbal.android.Pickup.State
- 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.
- COMPLETED - Enum constant in enum class com.gimbal.android.Pickup.State
- CONSENT_GRANTED - Enum constant in enum class com.gimbal.android.PrivacyManager.ConsentState
-
Consent has been granted by the user
- CONSENT_REFUSED - Enum constant in enum class com.gimbal.android.PrivacyManager.ConsentState
-
Consent has been refused by the user
- CONSENT_UNKNOWN - Enum constant in enum class com.gimbal.android.PrivacyManager.ConsentState
-
Consent is unknown -- typically because the user has not yet been asked for consent
- Coordinate - Class in com.gimbal.android
- Coordinate() - Constructor for class com.gimbal.android.Coordinate
- createNotification() - Method in class com.gimbal.android.ForegroundLocationService
- createPickup(PickupRequest) - Method in class com.gimbal.android.PickupManager
- CREATOR - Static variable in class com.gimbal.android.Pickup
- currentVisits() - Method in class com.gimbal.android.PlaceManager
- customerId(String) - Method in class com.gimbal.android.PickupRequest.Builder
D
- deleteUserAnalyticsID() - Method in class com.gimbal.android.AnalyticsManager
-
Disassociates a User Analytics Identifier from an application instance
- describeContents() - Method in class com.gimbal.android.Pickup
- DeviceAttributesManager - Class in com.gimbal.android
-
Encrypts and stores key-value pairs
- 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
- emitError(Context, InternalPickup, String) - Static method in class com.gimbal.android.OnTheWayService
- emitPickup(Context, InternalPickup) - Static method in class com.gimbal.android.OnTheWayService
- 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
-
Deprecated.
- enablePushMessaging(boolean) - Static method in class com.gimbal.android.Gimbal
-
Deprecated.
- 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.Pickup
- equals(Object) - Method in class com.gimbal.android.Place
- equals(Object) - Method in class com.gimbal.android.Push
-
Deprecated.
- 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
F
- ForegroundLocationBinder() - Constructor for class com.gimbal.android.ForegroundLocationService.ForegroundLocationBinder
- ForegroundLocationService - Class in com.gimbal.android
- ForegroundLocationService() - Constructor for class com.gimbal.android.ForegroundLocationService
- ForegroundLocationService.ForegroundLocationBinder - Class in com.gimbal.android
- FULFILLED - Enum constant in enum class com.gimbal.android.PickupManager.PickupCompletionReason
G
- getAllKeys() - Method in interface com.gimbal.android.Attributes
- getApplicationInstanceIdentifier() - Static method in class com.gimbal.android.Gimbal
-
Returns the instance identifier
String
for 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.Pickup
- getAttributes() - Method in class com.gimbal.android.PickupRequest
- 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
- getCustomerId() - Method in class com.gimbal.android.PickupRequest
- getDeliveryDate() - Method in class com.gimbal.android.Communication
- getDepartureTimeInMillis() - Method in class com.gimbal.android.Visit
- getDescription() - Method in class com.gimbal.android.Communication
- getDeviceAttribute(String) - Method in class com.gimbal.android.DeviceAttributesManager
- 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.Pickup
- getIdentifier() - Method in class com.gimbal.android.Place
- getInstance() - Static method in class com.gimbal.android.AnalyticsManager
-
Provides an instance of AnalyticsManager which handles analytics features
- 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.PickupManager
- 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. - getNotificationId() - Method in class com.gimbal.android.ForegroundLocationService
- getOpenPickups() - Method in class com.gimbal.android.PickupManager
- getPickup(String) - Method in class com.gimbal.android.PickupManager
- getPlace() - Method in class com.gimbal.android.Visit
- getPlaceIdentifier() - Method in class com.gimbal.android.Pickup
- getPlaceUuid() - Method in class com.gimbal.android.PickupRequest
- getPushType() - Method in class com.gimbal.android.Push
-
Deprecated.
- 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
. - getState() - Method in class com.gimbal.android.Pickup
- getTemperature() - Method in class com.gimbal.android.Beacon
-
Temperature of transmitter in fahrenheit.
- getTimeInMillis() - Method in class com.gimbal.android.BeaconSighting
- getTimeSinceLastDesync() - Method in class com.gimbal.android.Pickup
- 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 Class 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 class 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
-
Deprecated.
- handleNewToken(String) - Method in class com.gimbal.android.CommunicationManager
-
Deprecated.
- hashCode() - Method in class com.gimbal.android.Pickup
- HIGH - Enum constant in enum class com.gimbal.android.Beacon.BatteryLevel
I
- identifier(String) - Method in class com.gimbal.android.Pickup.PickupBuilder
- INSTANT - Enum constant in enum class com.gimbal.android.Push.PushType
-
Deprecated.
- 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 thePlaceManager
,CommunicationManager
andEstablishedLocationsManager
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
- LOW - Enum constant in enum class com.gimbal.android.Beacon.BatteryLevel
M
- MEDIUM_HIGH - Enum constant in enum class com.gimbal.android.Beacon.BatteryLevel
- MEDIUM_LOW - Enum constant in enum class com.gimbal.android.Beacon.BatteryLevel
N
- NOT_REQUIRED - Enum constant in enum class com.gimbal.android.PrivacyManager.GdprConsentRequirement
-
GDPR user consent is not required at this location - it may be required at a different location
O
- ON_THE_WAY - Enum constant in enum class com.gimbal.android.Pickup.State
- onBeaconSighting(BeaconSighting) - Method in class com.gimbal.android.BeaconEventListener
- onBeaconSighting(BeaconSighting, List<Visit>) - Method in class com.gimbal.android.PlaceEventListener
- onBind(Intent) - Method in class com.gimbal.android.ForegroundLocationService
- onCreate() - Method in class com.gimbal.android.ForegroundLocationService
- onError(String, Pickup) - Method in class com.gimbal.android.OnTheWayService
- onHandleWork(Intent) - Method in class com.gimbal.android.OnTheWayService
- onNotificationClicked(List<Communication>) - Method in class com.gimbal.android.CommunicationListener
-
Called when a user clicks on a Gimbal Notification in the notification tray
- onStateChanged(Pickup) - Method in class com.gimbal.android.OnTheWayService
- OnTheWayService - Class in com.gimbal.android
- OnTheWayService() - Constructor for class com.gimbal.android.OnTheWayService
- onUnbind(Intent) - Method in class com.gimbal.android.ForegroundLocationService
- 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
- OPEN - Enum constant in enum class com.gimbal.android.Pickup.State
- OTHER - Enum constant in enum class com.gimbal.android.PickupManager.PickupCompletionReason
P
- Pickup - Class in com.gimbal.android
- Pickup(Parcel) - Constructor for class com.gimbal.android.Pickup
- Pickup.PickupBuilder - Class in com.gimbal.android
- Pickup.State - Enum Class in com.gimbal.android
- PickupBuilder() - Constructor for class com.gimbal.android.Pickup.PickupBuilder
- PickupManager - Class in com.gimbal.android
- PickupManager.PickupCompletionReason - Enum Class in com.gimbal.android
- PickupRequest - Class in com.gimbal.android
- PickupRequest.Builder - Class in com.gimbal.android
- 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
- placeIdentifier(String) - Method in class com.gimbal.android.Pickup.PickupBuilder
- PlaceManager - Class in com.gimbal.android
- PLACES_CONSENT - Enum constant in enum class com.gimbal.android.PrivacyManager.ConsentType
-
Indicates a choice for consent to Place Monitoring functionality
- placeUuid(String) - Method in class com.gimbal.android.PickupRequest.Builder
- prepareCommunicationForDisplay(Communication, Push, int) - Method in class com.gimbal.android.CommunicationListener
-
Deprecated.
- 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()
. - presentNotificationForCommunications(Collection<Communication>, Push) - Method in class com.gimbal.android.CommunicationListener
-
Deprecated.
- presentNotificationForCommunications(Collection<Communication>, Visit) - Method in class com.gimbal.android.CommunicationListener
-
Called when a Place Arrival results in Gimbal Communications retrieved from Gimbal Manager.
- 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 Class in com.gimbal.android
-
Indicates the consent chosen by the user
- PrivacyManager.ConsentType - Enum Class in com.gimbal.android
-
The Gimbal SDK feature that may be consented to
- PrivacyManager.GdprConsentRequirement - Enum Class in com.gimbal.android
-
Indicates the requirement for user consent for SDK operation under the GDPR
- Push - Class in com.gimbal.android
-
Deprecated.
- Push() - Constructor for class com.gimbal.android.Push
-
Deprecated.
- Push.PushType - Enum Class in com.gimbal.android
-
Deprecated.
R
- removeDeviceAttribute(String) - Method in class com.gimbal.android.DeviceAttributesManager
-
Removes a specific key-value pair from device attributes
- 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 receiveCommunication
s - removeListener(PlaceEventListener) - Method in class com.gimbal.android.PlaceManager
- removeListener(LocationCallback) - Method in class com.gimbal.android.ForegroundLocationService.ForegroundLocationBinder
- REQUIRED - Enum constant in enum class com.gimbal.android.PrivacyManager.GdprConsentRequirement
-
GDPR user consent is required at this location
- REQUIREMENT_UNKNOWN - Enum constant in enum class com.gimbal.android.PrivacyManager.GdprConsentRequirement
-
GDPR user consent status is not yet known - The Gimbal SDK has not yet been able to contact its server
- 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
- setDeviceAttribute(String, String) - Method in class com.gimbal.android.DeviceAttributesManager
-
Adds new attributes to device attributes
- setDeviceAttributes(Map<String, String>) - Method in class com.gimbal.android.DeviceAttributesManager
-
Deprecated.
- setNotificationChannelId(String) - Method in class com.gimbal.android.CommunicationManager
-
Specifies a
NotificationChannel
to be used by Communication notifications. - setUserAnalyticsID(String) - Method in class com.gimbal.android.AnalyticsManager
-
Associates a User Analytics Identifier with an application instance.
- setUserAwaitingItemForPickup(String, boolean) - Method in class com.gimbal.android.PickupManager
- 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
- startMonitoringPickup(String) - Method in class com.gimbal.android.PickupManager
- startReceivingCommunications() - Method in class com.gimbal.android.CommunicationManager
-
Enables the CommunicationManager to receive Gimbal Communications from Gimbal Manager and deliver them to end users
- state(Pickup.State) - Method in class com.gimbal.android.Pickup.PickupBuilder
- 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
- stopMonitoringPickupWithReason(String, PickupManager.PickupCompletionReason) - Method in class com.gimbal.android.PickupManager
- stopReceivingCommunications() - Method in class com.gimbal.android.CommunicationManager
-
Stops all communication delivery.
T
- TIME_TRIGGERED - Enum constant in enum class com.gimbal.android.Push.PushType
-
Deprecated.
- timeOfLastServerRequest(Long) - Method in class com.gimbal.android.Pickup.PickupBuilder
- 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.Pickup
- toString() - Method in class com.gimbal.android.Place
- toString() - Method in class com.gimbal.android.Push
-
Deprecated.
- toString() - Method in class com.gimbal.android.Visit
V
- valueOf(String) - Static method in enum class com.gimbal.android.Beacon.BatteryLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.gimbal.android.Pickup.State
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.gimbal.android.PickupManager.PickupCompletionReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.gimbal.android.PrivacyManager.ConsentState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.gimbal.android.PrivacyManager.ConsentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.gimbal.android.PrivacyManager.GdprConsentRequirement
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.gimbal.android.Push.PushType
-
Deprecated.Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.gimbal.android.Beacon.BatteryLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.gimbal.android.Pickup.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.gimbal.android.PickupManager.PickupCompletionReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.gimbal.android.PrivacyManager.ConsentState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.gimbal.android.PrivacyManager.ConsentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.gimbal.android.PrivacyManager.GdprConsentRequirement
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.gimbal.android.Push.PushType
-
Deprecated.Returns an array containing the constants of this enum class, in the order they are declared.
- Visit - Class in com.gimbal.android
- Visit() - Constructor for class com.gimbal.android.Visit
W
- writeToParcel(Parcel, int) - Method in class com.gimbal.android.Pickup
All Classes and Interfaces|All Packages|Serialized Form
CommunicationManager.enablePushMessaging()
instead