Use this method to access the main object with which you can access to all the API functionality.

+ (Messangi *)sharedInstance;

Messangi *messangi = [Messangi sharedInstance];

This method returns the shared instance of the Messangi's object.

One of the first init steps, this method will start the Fences & Beacon monitoring process.

- (void)initMessangi:(BOOL)first;

[[Messangi sharedInstance] initMessangi:true];

One of the first init steps, this method will start the Fences & Beacon monitoring process.

- (void)initMessangi;

None

[[Messangi sharedInstance] initMessangi:true];

Set the Name for your App, useful if you have more that one iOS App to use with Messangi SDK

- (void)setAppName:(NSString *)newName;

[[Messangi sharedInstance] setAppName: @"example_app_name"];

As part of the initialization process you need to set you ID as a client to Messangi SDK, this allow Messangi SDK to route properly your traffic to your App.

- (void)setClientID:(NSString *)newClientID;

    [[Messangi sharedInstance] setClientID: @"example_client_id"];

When you complete the registration process with the Messangi SDK team, you will receive some credentials values as a Messangi's client.

One of those credentials is a private key, you need to use this private key when you are conecting your app with Messangi SDK. The SDK will use it internally to sign properly all your requests.

- (void)setApiClientPrivateKey:(NSString *)newPrivateKey;

[[Messangi sharedInstance] setApiClientPrivateKey: @"example_private_key"];

This URL is related to the Campaign Manager where you want to have and manage your distribution lists. It will be used every time the user wants to join or leave a distribution list.

- (void)setSubscriptionURL:(NSString *)newURL;

[[Messangi sharedInstance] setSubscriptionURL:@"example_url_base/rest/api"];

This ID is related to the workspace on the Campaign Manager which you want to work with. It will be used every time the user wants to join or leave a distribution list.

- (void)setSubscriptionInstanceID:(NSString *)newID;

[[Messangi sharedInstance] setSubscriptionInstanceID:@"example_workspace_id"];

As part of the initialization process, this method will establish a bind between the device and the Messangi SDK, this bind will be used for sending PUSH notifications to the device.

This method is used internally by registerDeviceToken method.

- (void)deviceSubscriberWithUniqueID;

[[Messangi sharedInstance] deviceSubscriberWithUniqueID];

Generates an unique device identifier and register the device with Messangi SDK.

- (void)registerDeviceToken:(NSData *)deviceToken;

[[Messangi sharedInstance] registerDeviceToken:deviceToken];

In iOS like in other mobile OS it's possible to monitor geographical regions, by monitoring it, the device is capable of trigger an event when gets inside of a given area. Unfortunately iOS limits the amount of simultaneous geographical fences to 20. Read more about this at the Developer's Apple online documentation.

This method will review the proximity and conditions of all relevant GeoFences and select the closest 20 from the global list to keep track of those, please note that this method will also be used by Messangi SDK itself.

- (void)refreshMonitoredRegionsToClosest;

[[Messangi sharedInstance] refreshMonitoredRegionsToClosest];

You can create multiples Distribution Lists with the Campaign Manager to reach different user's groups.

Those Distributions Lists can be populated using multiples techniques, this method allows the user to suscribe to a List.

- (void)subscribeToList:(NSString *)subscriptionID;

[[Messangi sharedInstance] subscribeToList:@"example_value"];

You can create multiples Distribution Lists with the Campaign Manager to reach different user's groups.

Registered users can leave a list any time they want, this method allows the user to unsubscribe from a list.

- (void)unsubscribeFromList:(NSString *)subscriptionID;

[[Messangi sharedInstance] unsubscribeFromList:@"example_value"];

We recommend when using Messangi SDK passing every PUSH notification you receive to the SDK first, if the PUSH is not relevant to the SDK it will let you handle the message your own way.

The SDK spect multiples message types, most of those are silent to the user, that's why we recommend to let the SDK process the incoming PUSH notification first.

- (BOOL)didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler;

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler
{
    if ([[Messangi sharedInstance] didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler]) {
        /*
         * Messangi SDK already handled the PUSH notification
         * You can add code here to performing an additional operation
         */
    } else {
        /*
         * Notification received was not wanted by Messangi
         * This notification must be managed by host App here
         */
    }
}

true if the PUSH was processed by the SDK, false if not

This method is used internally by messangi's didReceiveRemoteNotification method. It will fetch all pending messages you have stored at Messangi.

- (void)getUnreadMessages;

[[Messangi sharedInstance] getUnreadMessages];

Start Apple's Location Services from CoreLocation Framework. This method is internally called by initMessangi method.

- (void)startStandardUpdates;

[[Messangi sharedInstance] startStandardUpdates];

This in an internal method, this method report the current device location and is automatically fired by didReceiveRemoteNotification method.

- (void)sendLastLocationForMsgID:(NSString *)msgID withHandler:(void (^)(UIBackgroundFetchResult))completionHandler;

[[Messangi sharedInstance] sendLastLocationForMsgID:ex_msgID withHandler:ex_completionHandler];

This method verifies if the location services are ON at the moment

- (BOOL)statusLocationServicesOK;

[[Messangi sharedInstance] statusLocationServicesOK]

true if the location service is ON, false if not

Return all GeoFences currently monitored by the App.

- (NSSet *)monitoredGeoFences;

[Messangi monitoredGeoFences]

NSSet containing CLRegion objects, each one represents a monitored GeoFence.

Log events with Messangi SDK, they will be available to review later in our Kibana

- (void)logEvent:(NSString *)eventType andExtraInfo:(NSString *)extraInfo;

[[Messangi sharedInstance] logEvent:@"example_type" andExtraInfo:@"example_additional_info"];