API Documentation

1. Add the Google Services plugin as the last entry in your app level build.gradle file:

apply plugin: ‘com.google.gms.google-services’  // Google Play services Gradle plugin // Step

1. Add google services plugin to root level build.gradle file as below

dependencies {
    classpath ‘com.google.gms:google-services:4.3.4’
    // …
}

1. Add Firebase to your project as described in the following link:

https://firebase.google.com/docs/cloud-messaging/android/client

1. Download google-services.json file (from firebase) and place in the app folder of the project structure.
2. Note down the firebase project server key from the project created in Firebase console. (Project settings 🡪 Cloud Messaging 🡪 Server Key). 

Note: This server key is used in later steps to send notification from Server / rest client

1. Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-Telligent.

There are 2 methods in helping the authentication process:

1. CheckToken: – This is a method which looks for the authentication token in the 

application cache. (This will be by default false in the first run).

1. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

userName – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – Gender (OpenAPI library class)

getInstance().authorization(email, mobileNumber, userName, password, partnerToken, Gender.FEMALE, new Consumer<Boolean>() {
    @Override
    public void accept(Boolean status) {
        CommonUtils.closeDialog(MainActivity.this);
        if (status) {
            Log.v(TAG, “Sign in received success”);
            registerPushNotification();

        } else {
            Log.v(TAG, “Sign in received failure”);
        }
    }
});

1. The following steps need to be added to the Application class and performed one time on 

initial launch of the mobile application:

1. Initialize Open API 

Make a call to OpenAPI.init() method from Open API as described below

1. Setup configuration

OpenAPI.Configuration configuration = new OpenAPI.Configuration.Builder()
        .setAppVersion(BuildConfig.VERSION_CODE).setDebug(true). .setEnvironment(Environment.RELEASE).build();
OpenAPI.init(getApplicationContext(), configuration);

1. By default, OpenAPI library would be connecting to Production servers. Environment.RELEASE is the default configuration. You can change to Environment.DEV, to switch between Prod and Dev servers.

OpenAPI.Configuration configuration = new OpenAPI.Configuration.Builder()
        .setAppVersion(BuildConfig.VERSION_CODE).setDebug(true). .setEnvironment(Environment. DEV).build();

1. Generate Device Token as described in the Firebase SDK link provided above
2. This token is required to pass on to in-telligent servers to send push notifications to the device. Below code snippet shows how to send the FCM device token to Server.

public static void main(String[] args) {
    OpenAPI.getInstance().registerPushToken((token,new Consumer<Boolean>() {
        @Override
        public void accept(Boolean status) {
            if (status)
                Log.v(TAG, “Device Token Sent to server”);
            else
                Log.v(TAG, “Failed to send. Please try again later.”);
        }
    });

1. Enable additional DND permission –

Some devices have additional DND settings to prevent the alert sounds. To handle the alerts in such devices, we need to request DND additional permission from user. If we enable the permission, the OpenAPI library will turn off the device DND for 60seconds to play sound and then turns off the DND again (automatic).

Make a call to the below method in the home activity to request this special permission. Without this permission also the app will work (make audible sound) in all the devices where 

DND additional settings are not manually enabled.

OpenAPI.checkDNDPermission(this);

1. Add the following permissions to the Manifest file (AndroidManifest.xml)

<uses-permission android:name=“android.permission.FLASHLIGHT” />
<uses-permission android:name=“android.permission.VIBRATE” />

<uses-permission android:name=“android.permission.INTERNET” />

<uses-permission android:name=“android.permission.MODIFY_AUDIO_SETTINGS” />

1. Add the following service to the Manifest file within <application> tag

<service android:name=“.FCMService”>
    <intent-filter>
        <action android:name=“com.google.firebase.MESSAGING_EVENT” />
    </intent-filter>
</service>

1. Setup the required Firebase methods as detailed in the following link:  

https://firebase.google.com/docs/cloud-messaging/android/receive

1. 1. Override the onReceiveMessage method to receive the message payload and call below “relayPushNotification” method with message payload in the onReceiveMessage of FirebaseService. 

OpenAPI.getInstance().relayPushNotification(pushNotification, this,new  CallReceiver());

Note: The notification will have three button option – 

1. 1. 1. Mark As Read
      2. Delete
      3. Open

                      The variations are – 

1. In some devices these buttons will be visible by default.
2. In some devices we need to expand notification to see the buttons.

                       The notification is in expandable form with following variations –

1. In some devices notification is expanded by default.
2. In some devices there will be arrow to expand.
3. In some devices on dragging down notification will expand.

Below is the callback receiver and call actions in the application receiver from the library.

public class CallReceiver extends HeadsUpNotificationActionReceiver {
    @Override

    public void onReceive(Context context, Intent intent) {
        super.onReceive(context, intent);

        if (intent != null && intent.getExtras() != null) {
            String action =  intent.getAction();
            PushNotification data = (PushNotification) intent.getSerializableExtra(Actions.CALL_NOTIFICATION);
            NotificationManager notificationManager = (NotificationManager)context.
                    getSystemService(Context.NOTIFICATION_SERVICE);
            notificationManager.cancel(Integer.parseInt(data.getNotificationId()));
            OpenAPI.getInstance().getAudioHelper().stopRingtone();
            if (action != null) {

                if (action.equals(Actions.ACTION_MARK_AS_READ) && data != null) {
                    Log.i(“CallReceiver”, “Mark as Read action”);

                } else if (action.equals(Actions.ACTION_DELETE)) {
                    Log.i(“CallReceiver”, “Delete action”);

                } else if (action.equals(Actions.ACTION_OPEN)) {
                    Log.i(“CallReceiver”, “Open action”);

                }
            }

1. In the project target folder 🡪 Capabilities 🡪 background modes enable the following:

• Audio, Airplay, and Picture in Picture
• Location updates
• Voice over IP
• Background fetch
• Remote notifications

2. In Capabilities, enable Push notifications.
3. Register the application with the bundle identifier in apple developer website (https://developer.apple.com/) and enable VOIP services on the apple developer portal with the app ID and then create:

• 1. Certificates: (Refer to the attached document – iOS Certificates creation process)
  2. Profiles: (Refer to the attached document – iOS Certificates creation process)
  3. Integrate: Install certificates by double clicking on the certificates. This is to run the development application in iPhone physical device and to send push notification using Pusher client.

Ref: (attached document – iOS Certificates creation process)

4. For VOIP services, 

• Generate a P8 file in KEYS section in developer portal (Ref: attached document – iOS Certificates creation process)
• Download the generated file
• Integrate the above certificates with backend web services, which will initiate the notification (app owner’s server)

5. Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-Telligent.

There are 2 methods in helping the authentication process:

1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

name – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – OpenAPIUserGender (OpenAPI library class)

1. For further use, need to capture device tokens from the following delegates methods

1. In Order to receive PushKit notification / Regular notification from In-telligent server, need to register captured device tokens (Regular Push token and VoIP Push token) with In-telligent using OpenAPI method “registerPushKitToken” as below,

1. When the Regular push notification payload is received on the delegate method, call the 

Open API method relayPushKitNotification and pass the received payload. The Open API library will handle the notification with the appropriate sound.

1. When the PushKit payload is received on the delegate method, call the Open API method relayPushKitNotification and pass the received payload.   The Open API library will handle the notification with the appropriate sound.

The auto subscription feature will subscribe or un-subscribe a device based on device location change events.  Once this functionality has been invoked, every user / device will automatically update into or out of In-telligent communities when entering or leaving a Geo fence. 

To implement this functionality, the following steps must be taken.

• Initialize Open API 

The following method call need to be added to the Application class and performed one time on initial launch of the mobile application

      Make a call to OpenAPI.init() method from Open API

• Authentication: Before we call any service from OpenAPI, we need to authenticate the 

Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

userName – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – Gender (OpenAPI library class)

getInstance().authorization(email, mobileNumber, userName, password, partnerToken, Gender.FEMALE, new Consumer<Boolean>() {
    @Override
    public void accept(Boolean status) {
        CommonUtils.closeDialog(MainActivity.this);
        if (status) {
            Log.v(TAG, “Sign in received success”);
            registerPushNotification();

        } else {
            Log.v(TAG, “Sign in received failure”);
        }
    }
});

• Auto Subscription: After authentication, the following method is used to initiate the auto subscription process: 

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_communities);

    OpenAPI.currentSubscriberDidChange(CommunitiesListActivity.this, new Consumer<SubscriberResponse>() {
        @Override
        public void accept(SubscriberResponse subscriberResponse) {
            if (subscriberResponse != null) {
                Log.v(TAG, “SubscriberCommunities  received success”);

                // Adding communities to list adapter UI
                mAdapter = new CommunitiesListAdapter(subscriberResponse.getSubscriber().getBuildings());
                recyclerView.setAdapter(mAdapter);

            } else {
                Log.v(TAG, “SubscriberCommunitiesreceived failure”);
            }
        }
    });

This will handle the following functionality:

1. 1. Handling location change Events:
      1. Get the device location and listen for subsequent location change events.
      2. Retrieving the Geo fence from server and automatically will add / remove Geo fence boundaries to / from the device.
   2. Get communities and Subscribe to new communities list from server.
      1. Get list of communities from In-telligent server API.
      2. Auto subscribe to the received communities from API.

The above method is to be called after authorization and whenever app needs to start Auto-Subscription.

• Community lists for a subscriber: 

After auto subscription has been invoked, handle callback method – currentSubscriberDidChange () – to get a list of all communities that a device has been auto subscribed.  The following is a code snippet for this method:  

OpenAPI.currentSubscriberDidChange(CommunitiesListActivity.this,new Consumer<SubscriberResponse>() {
        @Override

        public void accept(SubscriberResponse subscriberResponse) {

            if (subscriberResponse != null) {
                Log.v(TAG, “Subscriber Communities  received success”);
                subscriberResponse.subscriber.buildings

            } else {
                Log.v(TAG, “SubscriberCommunitiesreceived failure”);
            }
        }
    });
} catch (Exception e) {
        e.printStackTrace();
}

• Permissions:

Add the following Geo Fence services to the application manifest.xml file and then handle the permission request.

<uses-permission android:name=“android.permission.FLASHLIGHT” />
<uses-permission android:name=“android.permission.VIBRATE” />
<uses-permission android:name=“android.permission.INTERNET”/>
<uses-permission android:name=“android.permission.MODIFY_AUDIO_SETTINGS” />

The auto subscription feature will subscribe or un-subscribe a device based on device location change events.  Once this functionality has been invoked, every user / device will automatically update into or out of In-telligent communities when entering or leaving a Geo fence. 

To implement this functionality, the following steps must be taken.

• Initialize Open API 

The following method call need to be added to the Application class and performed one time on initial launch of the mobile application

      Make a call to OpenAPI.init() method from Open API

• Authentication: Before we call any service from OpenAPI, we need to authenticate the 

Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

userName – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – Gender (OpenAPI library class)

getInstance().authorization(email, mobileNumber, userName, password, partnerToken, Gender.FEMALE, new Consumer<Boolean>() {
    @Override
    public void accept(Boolean status) {
        CommonUtils.closeDialog(MainActivity.this);
        if (status) {
            Log.v(TAG, “Sign in received success”);
            registerPushNotification();

        } else {
            Log.v(TAG, “Sign in received failure”);
        }
    }
});

• Auto Subscription: After authentication, the following method is used to initiate the auto subscription process: 

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_communities);

    OpenAPI.currentSubscriberDidChange(CommunitiesListActivity.this, new Consumer<SubscriberResponse>() {
        @Override
        public void accept(SubscriberResponse subscriberResponse) {
            if (subscriberResponse != null) {
                Log.v(TAG, “SubscriberCommunities  received success”);

                // Adding communities to list adapter UI
                mAdapter = new CommunitiesListAdapter(subscriberResponse.getSubscriber().getBuildings());
                recyclerView.setAdapter(mAdapter);

            } else {
                Log.v(TAG, “SubscriberCommunitiesreceived failure”);
            }
        }
    });

This will handle the following functionality:

1. 1. Handling location change Events:
      1. Get the device location and listen for subsequent location change events.
      2. Retrieving the Geo fence from server and automatically will add / remove Geo fence boundaries to / from the device.
   2. Get communities and Subscribe to new communities list from server.
      1. Get list of communities from In-telligent server API.
      2. Auto subscribe to the received communities from API.

The above method is to be called after authorization and whenever app needs to start Auto-Subscription.

• Community lists for a subscriber: 

After auto subscription has been invoked, handle callback method – currentSubscriberDidChange () – to get a list of all communities that a device has been auto subscribed.  The following is a code snippet for this method:  

OpenAPI.currentSubscriberDidChange(CommunitiesListActivity.this,new Consumer<SubscriberResponse>() {
        @Override

        public void accept(SubscriberResponse subscriberResponse) {

            if (subscriberResponse != null) {
                Log.v(TAG, “Subscriber Communities  received success”);
                subscriberResponse.subscriber.buildings

            } else {
                Log.v(TAG, “SubscriberCommunitiesreceived failure”);
            }
        }
    });
} catch (Exception e) {
        e.printStackTrace();
}

• Permissions:

Add the following Geo Fence services to the application manifest.xml file and then handle the permission request.

<uses-permission android:name=“android.permission.FLASHLIGHT” />
<uses-permission android:name=“android.permission.VIBRATE” />
<uses-permission android:name=“android.permission.INTERNET”/>
<uses-permission android:name=“android.permission.MODIFY_AUDIO_SETTINGS” />

The language translation feature will translate community notifications from the original language to any other supported language. 

To implement this functionality, the following steps must be taken.

1.   Initialize Open API 

The following method call need to be added to the Application class and performed one time on initial launch of the mobile application

      Make a call to OpenAPI.init() method from Open API

2.   Authentication: Before we call any service from OpenAPI, we need to authenticate the 

Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

userName – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – Gender (OpenAPI library class)

getInstance().authorization(email, mobileNumber, userName, password, partnerToken, Gender.FEMALE, new Consumer<Boolean>() {
    @Override
    public void accept(Boolean status) {
        CommonUtils.closeDialog(MainActivity.this);
        if (status) {
            Log.v(TAG, “Sign in received success”);
            registerPushNotification();

        } else {

            Log.v(TAG, “Sign in received failure”);
        }
    }
});

3.   Building Notifications: After authentication and getting buildings (refer to section 5.3 point 3) the following method is used to get notifications for buildings using building ID.

OpenAPI.getBuildingNotifications(this, new Consumer<HashMap<String, ArrayList<Notification>>>() {

        @Override
        public void accept(HashMap<String, ArrayList<Notification>> notificationsByBuilding) throws Exception {

//Printing the Notifications with building ID
            notificationsByBuildings.entrySet().forEach(entry->{
                System.out.println(entry.getKey() + ” ” + entry.getValue());
            });
            s
        }
    });

4.   List of Languages: After getting building notifications, the following method is used to get a list of languages supported for Notification translation. 

OpenAPI.getLanguages()

OpenAPI.getLanguages(new Consumer<NotificationLanguageResponse>() {
        @Override
        public void accept(NotificationLanguageResponse languageResponse) throws Exception {
            System.out.println(languageResponse.getLanguages());
        }
    });

5. Notification Translation: The method INLanguageManager.getTranslation() is used to retrieve the translated message and the title of the message. 

Parameters: notification ID and target language.

OpenAPI.getTranslation(id,languageValue,new Consumer<TranslationResponse>() {

        @Override
        public void accept(TranslationResponse translationResponse) throws Exception {

            System.out.println(translationResponse.getBody()),             System.out.println(translationResponse.getTitle());
        }
    });

The language translation feature will translate community notifications from the original language to any other supported language. 

To implement this functionality, the following steps must be taken.

• Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. 1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
   2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

name – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – OpenAPIUserGender (OpenAPI library class)

• Building Notifications: After authentication and getting buildings (refer to section 5.4 point 2) the following method is used to get notifications for buildings using “building id”.

INSubscriberManager.shared.getBuildingNotifications ()

• List of Languages: After getting building notifications, the following method is used to get a list of languages supported for Notification translation. 

INLanguageManager.getLanguages() 

• Notification Translation: The method INLanguageManager.getTranslation() is used to retrieve the translated message and the title of the message. 

Parameters: notification ID and target language.

INLanguageManager.getTranslation()

A Community manager can initiate this API to send community alert to subscribers of his community. This will allow us to send different types of alerts (Regular, Personal, Ping, Critical, LSA) with or without attachments from the mobile app.

To implement this functionality, the following steps must be taken.

Note: (To become a community manager for any given community, you need to contact admin)

Admin can add a Community Manager in In-telligent Web Portal. To register as a Manager, a valid email id / mobile number required. Once Admin adds a Community Manager for any given community, he will receive a link to set password. After setting the password, with that credentials Community Manager can login to the Mobile app.

• Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. 1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
   2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

name – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – OpenAPIUserGender (OpenAPI library class)

• Send Alert: After authentication with community manager credentials, you will be able to access the below API call with the necessary information. 

To get buildings list (refer to section 5.4 point 2). 

OpenAPI.sendAlert(title: alertTitle, message: alertMessage, building: buildingInformation, attachments: attachmentsInformation, notificationType: NotificationType)

Parameters: 

title – 

Required – Yes

Type – String

message – 

Required – Yes

Type – String

building – 

Required – Yes

Type – INBuilding (OpenAPI library class)

attachments – 

Required – Yes

Type – Array of CustomImage (OpenAPI library class)

notificationType – 

Required – Yes

Type – NotificationType (OpenAPI library class)

OpenAPI.sendAlert(title: title_value, message: message_value, building: building, attachments: attachments, notificationType: notification_type, success: {
        // Handle success response
    }) { (error) in
        // Handle error response
    }

A Community manager can initiate this API to send community alert to subscribers of his community. This will allow us to send different types of alerts (Regular, Personal, Ping, Critical, LSA) with or without attachments from the mobile app.

Note: (To become a community manager for any given community, you need to contact admin)

Admin can add a Community Manager in In-telligent Web Portal. To register as a Manager, a valid email id / mobile number required. Once Admin adds a Community Manager for any given community, he will receive a link to set password. After setting the password, with that credentials Community Manager can login to the Mobile app.

To implement this functionality, the following steps must be taken.

1.   Initialize Open API 

The following method call need to be added to the Application class and performed one time on 

initial launch of the mobile application

      Make a call to OpenAPI.init() method from Open API

2.   Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

userName – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – Gender (OpenAPI library class)

getInstance().authorization(email, mobileNumber, userName, password, partnerToken, Gender.FEMALE, new Consumer<Boolean>() {
    @Override
    public void accept(Boolean status) {
        CommonUtils.closeDialog(MainActivity.this);

        if (status) {
            Log.v(TAG, “Sign in received success”);
            registerPushNotification();

        } else {
            Log.v(TAG, “Sign in received failure”);

        }
    }
});

• Send Alert: After authentication with community manager credentials, you will be able to access the below API call with the necessary information. 

OpenAPI.sendAlert(buildingId, title, message, notificationType, attachmentPaths, new Consumer<SuccessResponse>() {

        @Override
        public void accept(SuccessResponse successResponse) throws Exception{
            if (successResponse != null && successResponse.isSuccess()) {
                Log.i(TAG, “Success”);

            }else{
                Log.i(TAG, “Error”);

            }

        }
    });

Parameters: 

title – 

Required – Yes

Type – String

message – 

Required – Yes

Type – String

buildingID – 

Required – Yes

                                   Type – String(To get building Id -refer to section 5.3 point 4). 

attachments – 

Required – optional

Type – Array of CustomImage Paths

notificationType – 

Required – Yes

Type – AlertType (OpenAPI library class)

The delivered alert status feature will inform the server about notification being delivered to the user. It will be done without developer’s action on receiving an alert.

The opened alert status feature will inform the server about notification being read by the user. 

To implement this functionality, the following steps must be taken.

1.   Initialize Open API 

The following method call need to be added to the Application class and performed one time on initial launch of the mobile application

      Make a call to OpenAPI.init() method from Open API

2.   Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

userName – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – Gender (OpenAPI library class)

getInstance().authorization(email, mobileNumber, userName, password, partnerToken, Gender.FEMALE, new Consumer<Boolean>() {
    @Override
    public void accept(Boolean status) {
        CommonUtils.closeDialog(MainActivity.this);
        if (status) {
            Log.v(TAG, “Sign in received success”);
            registerPushNotification();

        } else {
            Log.v(TAG, “Sign in received failure”);
        }
    }
});

• Call opened alert: After authentication, the following method is used to update server about alert opened status using notification ID.

 Parameters: 

notificationId – 

Required – Yes

Type – int

OpenAPI.alertOpened(notificationId, new Consumer< SuccessResponse>() {

        @Override
        public void accept(SuccessResponse successResponse) throws Exception {

            if (successResponse != null && successResponse.isSuccess()) {
// Opened status successfully sent to server
            } else if (successResponse != null) {
                Log.v(TAG, “Opened alert  failure “+ successResponse.getError());                               } else {
                Log.v(TAG, “Opened alert  failure “);
            }
        }
    });

The delete alert feature will enable a user to delete an alert. 

To implement this functionality, the following steps must be taken.

1.   Initialize Open API 

The following method call need to be added to the Application class and performed one time on initial launch of the mobile application

      Make a call to OpenAPI.init() method from Open API

2.   Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

userName – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – Gender (OpenAPI library class)

getInstance().authorization(email, mobileNumber, userName, password, partnerToken, Gender.FEMALE, new Consumer<Boolean>() {
    @Override
    public void accept(Boolean status) {
        CommonUtils.closeDialog(MainActivity.this);

        if (status) {
            Log.v(TAG, “Sign in received success”);
            registerPushNotification();

        } else {
            Log.v(TAG, “Sign in received failure”);
        }
    }
});

• Call delete alert: After authentication and receiving at least 1 alert, the following method is used to delete an alert using notification ID.

 Parameters: 

notificationId – 

Required – Yes

                        Type – int

OpenAPI.deleteAlert ()

OpenAPI.deleteAlert (notificationId, new Consumer< SuccessResponse>() {

        @Override
        public void accept(SuccessResponse successResponse) throws Exception {

            if (successResponse != null && successResponse.isSuccess()) {
// Alert successfully deleted
            } else if (successResponse != null) {
                Log.v(TAG, “Delete alert  failure “+ successResponse.getError());                               } else {
                Log.v(TAG, “Delete alert  failure “);
            }
        }
    });

The delivered alert status will inform the server about notification being delivered to the user. 

It will be done without developer’s action on receiving an alert.

The opened alert status feature will inform the server about notification being read by the user. 

To implement this functionality, the following steps must be taken

• Configure: 

In AppDelegate.swift file within didFinishLaunchingWithOptions method add the below

code to configure the API setup

• Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. 1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
   2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

name – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – OpenAPIUserGender (OpenAPI library class)

• Opened Alert: After authentication with community manager credentials, you will be able to access the below API call with the necessary information. 

To get buildings list (refer to section 5.4 point 2). 

OpenAPI.openedAlert(notificationId: notification_id)

Parameters: 

notificationId – 

Required – Yes

Type – Int

The delete alert feature will enable a user to delete an alert. 

To implement this functionality, the following steps must be taken.

• Configure: 

In AppDelegate.swift file within didFinishLaunchingWithOptions method add the below code to configure the setup for the API

• Authentication: Before we call any service from OpenAPI, we need to authenticate the Partner token which was received from In-telligent.

There are 2 methods for the authentication process:

1. 1. CheckToken: – This is a method which looks for the authentication token in the application cache. (This will be by default false in the first run).
   2. authorization: – If the authentication token is not available, checkToken method returns false. Then a call to “authorization” method is required to get the authentication token and store it in cache. 

Parameters: 

partnerToken – 

Required – Yes

Type – String

email/mobileNumber – 

Required – Yes

Type – String

password – 

Required – Yes

Type – String

name – 

Required – Yes (Name or empty string)

Type – String

Default – If empty, default is email/mobilenumber

gender – 

Required – Yes

Type – OpenAPIUserGender (OpenAPI library class)

• Delete Alert: After authentication with community manager credentials, you will be able to access the below API call with the necessary information. 

To get buildings list (refer to section 5.4 point 2). 

OpenAPI.deleteAlert(notificationId: notification_id)

Parameters: 

notificationId – 

Required – Yes

Type – Int