mediQuo Android SDK

Integration Example

You have a repository available on Bitbucket with a sample project which contains an example of how to integrate our SDK.

Prerequisites

  • A minSdkVersion of 23 (Android 6.0) or higher.
  • compileOptions set to Java 8.
  • The AndroidX versions of the Jetpack support libraries.
  • Firebase Cloud Messaging added in the project (Firebase Cloud Messaging documentation).
  • Compose must be configured on your project and it has to be at least version 2024.04.01. For instructions, follow this link.

Configuration

Add dependencies to project level build.gradle

Edit your build.gradle project level to add mediQuo and Tokbox maven repositories:

allprojects {
    repositories {
        google()
        jcenter()
        mavenCentral()
        maven { url "https://mediquo.jfrog.io/artifactory/android-sdk" }
        maven { url "https://mediquo.jfrog.io/artifactory/videocall-android" }
    }
}

Add dependencies to app level build.gradle

Edit your build.gradle app level to include mediQuo SDK lib as a dependency:

implementation 'com.mediquo:mediquo-sdk:[LAST-VERSION]'

You can see which is the last version in the changelog section of the documentation.

Make sure the app's build.gradle file contains the following code snippet within android section:

compileOptions {
     sourceCompatibility JavaVersion.VERSION_1_8
     targetCompatibility JavaVersion.VERSION_1_8
}

Include file_paths.xml file

Since Android 11 you must add a file named file_paths.xml in the res/xml directory of your app module for the file attachment to work properly.

Inside this file, you have to add the following code (make sure to replace your.package.name with the real value):

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <external-path name="my_images" path="Android/data/[your.package.name]/files/Pictures" />
    <external-path name="downloads" path="Android/data/[your.package.name]/files/Download" />
</paths>

On the other hand, for its correct operation, we must refer to this file in AndroidManifest.xml, addind the following code:

 <provider
    android:name="androidx.core.content.FileProvider"
    android:authorities="[your.package.name]"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/file_paths" />
</provider>

Life cycle

Initialization

The library must be initialized inside Application.onCreate() using your API_KEY provided by mediQuo. Make sure not to use any other library method before you receive a successful response in the listener.

class App : Application() {
    private val mediQuoInitListener = object : MediquoInitListener {
        override fun onFailure(message: String?) {
            /* Your initialization has failed */
        }

        override fun onSuccess() {
            /* Your initialization has been successful */
        }
    }

    override fun onCreate() {
        super.onCreate()
        MediquoSDK.initialize(this, API_KEY, mediQuoInitListener)
    }
 }

Authentication

To authenticate a patient, provide a valid CLIENT_CODE previously created with Patients API. Make sure not to use any other library method before you receive a successful response in the listener.

private val mediQuoAuthenticateListener = object : MediquoAuthenticateListener {
    override fun onFailure(message: String?) {
        /* Your authentication has failed */
    }

    override fun onSuccess() {
        /* Your authentication has been successful */
    }
}

private fun authenticateMediQuoSDK() {
    MediquoSDK.authenticate(CLIENT_CODE, mediQuoAuthenticateListener)
}

Logout

In order to delete the credentials and force a logout there is the deauthenticate method. You can, or not, pass a listener to offer the result obtained.

private val mediquoDeAuthenticateListener = object : MediquoDeAuthenticateListener {
    override fun onSuccess() {
        /* Your logout has been successful */
    }

    override fun onFailure(message: String?) {
        /* Your logout has failed */
    }
}

private fun authenticateMediQuoSDK() {
    MediquoSDK.deAuthenticate(mediquoDeAuthenticateListener)
}

Push notifications handling

In order to enable push notifications for chat and video call you must provide mediQuo a valid Firebase Private Key and register your push tokens in the SDK. The SDK will only process its own messages so you can send it all incoming pushes if you can't filter them properly.

class MediQuoSDKExampleMessagingService : FirebaseMessagingService() {
   override fun onMessageReceived(remoteMessage: RemoteMessage) {
       super.onMessageReceived(remoteMessage)
        
       /* Your code to process remoteMessage */
       
       /* Send remoteMessage to mediQuo SDK */
       MediquoSDK.getInstance()?.onFirebaseMessageReceived(remoteMessage)
   }

   override fun onNewToken(newToken: String) {
       super.onNewToken(newToken)
       /* Register push token to mediQuo SDK */
       MediquoSDK.getInstance()?.registerPushToken(newToken)
   }
}

Obfuscation

If you have the obfuscation enabled in your build.gradle file (minifyEnabled true) you need to add the next lines to your proguard-rules file:

-keep class com.opentok.** { *; }
-keep class org.webrtc.** { *; }
-keep class com.mediquo.ophiuchus.videocall.** { *; }
-keep class org.otwebrtc.** { *; }
-dontwarn com.opentok.**
-dontwarn org.webrtc.**
-dontwarn com.mediquo.ophiuchus.videocall.**
← TroubleshootingProfessional List →