StatusIQ-Android-SDK

Accessing services from anywhere at any time has been made possible with mobile applications. With businesses needing to ensure uninterrupted availability, it is crucial to keep customers aware of the status of services through mobile applications that provide transparency as well as ease of access. In this context, a public status page like StatusIQ can help you post real-time updates to keep your customers informed about your active incidents or scheduled maintenance. It also lets you publish postmortem reports and do much more. You can integrate your mobile applications with StatusIQ to help users track service status updates. The StatusIQ Android SDK is a free module for StatusIQ. The perk is that you can integrate the StatusIQ Android SDK with your company's mobile app and showcase your real-time service availability to clients. The integration is supported for the dark theme and provides various customization options, like changing the font and colors.

How to customize the StatusIQ Framework

You can customize the user interface for the StatusIQ Framework to suit your application theme.

To customize, use the StatusIq.setTheme() method before using the StatusIq.openStatusIqActivity() method. You can customize various aspects, like font, text color, and background color, by passing the custom theme.

      StatusIq.setTheme(R.style.Theme_StatusIQSDK)
      StatusIq.openStatusIqActivity(this@MainActivity, "Service status")

     <style name="Theme.StatusIQSDK" parent="Theme.MaterialComponents.DayNight.DarkActionBar">
       
        <!-- Customize your theme here. -->

        <!-- Primary color. -->
        <item name="colorPrimary">@color/purple_500</item>
        <item name="colorPrimaryVariant">@color/purple_700</item>
        <item name="colorOnPrimary">@color/white</item>
        <!-- Secondary color. -->
        <item name="colorSecondary">@color/teal_200</item>
        <item name="colorSecondaryVariant">@color/teal_700</item>
        <item name="colorOnSecondary">@color/black</item>
        <item name="textAllCaps">true</item>
        <!-- Text color. -->
        <item name="textColor">@color/white</item>
        <!-- statusIQCardBackgroundColor color. -->
        <item name="statusIQCardBackgroundColor">@color/backgroundColor</item>
        <!-- statusIqBackgroundColor color. -->
        <item name="statusIqBackgroundColor">@color/black</item>
        <!-- Status bar color. -->
        <item name="statusBarColor">@color/black</item>
        <!-- incidentItemCardBackgroundColor color. -->
        <item name="incidentItemCardBackgroundColor">@color/incidentItemBackgroundColor</item>

       
     </style>

Steps to integrate the StatusIQ Android SDK into your business app

1. Import the StatusIQ Android SDK into your business app by cloning the source code or by including the StatusIQ SDK.aar.

   Note: If you are importing the SDK as a .arr file, ensure that your app level build.gradle contains the following dependencies.

       implementation 'com.squareup.retrofit2:retrofit:2.9.0'
       implementation 'com.squareup.retrofit2:converter-scalars:2.3.0'
       implementation 'androidx.recyclerview:recyclerview:1.2.1'
       implementation "androidx.cardview:cardview:1.0.0"
       implementation 'androidx.constraintlayout:constraintlayout:2.1.2'
       implementation 'androidx.appcompat:appcompat:1.3.1'

2. After importing the SDK, it is important to specify the Status_page_url under defaultConfig in your app-level build.gradle.

        defaultConfig {

        applicationId "com.zoho.statusiqsdkapp"
        minSdkVersion 19
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        resValue "string", "Status_page_url", "https://status.site24x7.com/"

       }

3. If you wish to show only the status of a specific component, then add two more values, Show_Component_status_alone and Component_Name, as shown below:

        defaultConfig {

        applicationId "com.zoho.statusiqsdkapp"
        minSdkVersion 19
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        resValue "string", "Status_page_url", "https://status.site24x7.com/"
        resValue "string", "Show_Component_status_alone", "1"
        resValue "string", "Component_Name","Site24x7 StatusIQ"
  
       }

4. After entering these details, rebuild your project and use the StatusIq.openStatusIqActivity() method to display the status screen. The first parameter is the context, and the second parameter is the title you wish to display on the action bar.

      StatusIq.openStatusIqActivity(this@MainActivity, "Service status")