Gimbal Class Reference
Inherits from | NSObject |
---|---|
Declared in | Gimbal.h |
Overview
The Gimbal class contains functions that handle the global configuration of the Gimbal framework.
+ setAPIKey:options:
Sets the API for your Gimbal application.
+ (void)setAPIKey:(NSString *)APIKey options:(nullable NSDictionary *)options
Parameters
APIKey |
The client API key for your Gimbal application. Passing nil for the api key will throw an exception |
---|---|
options |
The options you’d like to start the Gimbal application with |
Discussion
Sets the API for your Gimbal application.
This also prompts the user for access to their location. By default the user will be prompted with the options “Always”, “While in use” or “Never”. You can manage this request on your own in the options parameter by setting the key “MANAGE_PERMISSIONS” with a value of NO.
Declared In
Gimbal.h
+ start
Starts all the Gimbal services which includes the generation of events based on the user’s location and proximity to geofences and beacons, receive communications associated to place entry and exit events and generation of established locations based on the user’s locations. It’s a method for starting the GMBLPlaceManager, GMBLCommunicationManager and GMBLEstablishedLocationManager. These features can also be controlled server side anytime for a specific application using advanced configuration at manager.gimbal.com
+ (void)start
Discussion
Starts all the Gimbal services which includes the generation of events based on the user’s location and proximity to geofences and beacons, receive communications associated to place entry and exit events and generation of established locations based on the user’s locations. It’s a method for starting the GMBLPlaceManager, GMBLCommunicationManager and GMBLEstablishedLocationManager. These features can also be controlled server side anytime for a specific application using advanced configuration at manager.gimbal.com
Declared In
Gimbal.h
+ stop
Stops all the Gimbal services. Its a method for stoping the GMBLPlaceManager, GMBLCommunicationManager and GMBLEstablishedLocationManager.
+ (void)stop
Discussion
Stops all the Gimbal services. Its a method for stoping the GMBLPlaceManager, GMBLCommunicationManager and GMBLEstablishedLocationManager.
Declared In
Gimbal.h
+ isStarted
Returns the Gimbal services state. It will return false if start was not called, or stop was called, on GMBLPlaceManager, GMBLCommunicationManager and GMBLEstablishedLocationManager
+ (BOOL)isStarted
Discussion
Returns the Gimbal services state. It will return false if start was not called, or stop was called, on GMBLPlaceManager, GMBLCommunicationManager and GMBLEstablishedLocationManager
Declared In
Gimbal.h
+ applicationInstanceIdentifier
Returns the application instance identifier that is unique across your users
+ (nullable NSString *)applicationInstanceIdentifier
Return Value
The string that identifies this application instance
Discussion
Returns the application instance identifier that is unique across your users
Declared In
Gimbal.h
+ resetApplicationInstanceIdentifier
Generates a new applicationInstanceIdentifier and future events will only be associated to the newly created instance identifier.
+ (void)resetApplicationInstanceIdentifier
Discussion
Generates a new applicationInstanceIdentifier and future events will only be associated to the newly created instance identifier.
Declared In
Gimbal.h
+ setPushDeviceToken:
Allows Gimbal to send push notifications through Apple’s APN system to a specific device
+ (void)setPushDeviceToken:(nullable NSData *)deviceToken
Parameters
deviceToken |
The device token from the ApplicationDelegate callback application:didRegisterForRemoteNotificationsWithDeviceToken: |
---|
Discussion
Allows Gimbal to send push notifications through Apple’s APN system to a specific device
Declared In
Gimbal.h