Collect SDK information from an app install

Detect SDK installation

To detect if the SDK is installed, use the following code:

// Detecting if Acoustic SDK is installed 
try {
    Class.forName("co.acoustic.mobile.push.sdk.api.MceSdk");
    System.out.println("Acoustic SDK installed");
} catch (ClassNotFoundException e) {
  System.out.println("Acoustic SDK not installed");
}

Check SDK version

Use the following code to acquire the version of the SDK:

String versionNum = MceSdk.getSdkVerNumber(); 
System.out.println("Acoustic SDK Version: " + versionNum); 

Retrieve SDK registration details

The registration details include important values that are related to the SDK registration for each unique app install.

📘

Note:

The registration detail properties are not available until the device is registered. Registration happens within seconds of first launching your mobile app.

The Android SDK registration includes the following properties:

• channel ID
• user ID
• Is push registered - a flag that indicates whether the device is registered with FCM (true if registered, false if not registered).
• Push token - the registration ID received from FCM after registration. This value is null if registration has not been performed yet.

You can get the registration details using the following methods:

1. Grab the details properties in Java.
   The following example shows you how to grab the details properties in Java:
   Java

   
   RegistrationDetails registrationDetails = MceSdk.getRegistrationClient().getRegistrationDetails(getApplicationContext());
   String channelId= registrationDetails.getChannelId();
   String userId=registrationDetails.getUserId();
   boolean isPushRegistered= registrationDetails.isPushRegistered();
   String pushToken= registrationDetails.getPushToken();
   String appKey = MceSdk.getRegistrationClient().getAppKey(getApplicationContext());
   

2. Implement the MceBroadcastReceiver class to get the registration details and send them to your server
   The MceBroadcastReceiver class retrieves the user ID and channel ID in the onSdkRegistered method by using the MceSdk.getRegistrationDetails().getUserId() and MceSdk.getRegistrationDetails().getChannelId() methods.
3. Obtain MCE registration details by using MceNotificationActionRegistry
   MceNotificationActionRegistry is for registering custom SDK notification actions.
4. Implement onDeliveyChannelRegistered method
   If you want to obtain the push token, you must implement the onDeliveyChannelRegistered method and use the 'MceSdk.getRegistrationDetails().getPushToken()' method.

To get the registration details when using React Native, you must add the listener methods below and then retrieve the registration details. Once retrieved, you can then use these values or send them to your service and associate the values with a named user account.

import {RNAcousticMobilePush} from 'NativeModules';
import {NativeEventEmitter} from 'react-native';
const emitter = new NativeEventEmitter(RNAcousticMobilePush);

emitter.addListener('Registered', ()=>{ updateRegistration(); });
emitter.addListener('RegistrationChanged', ()=>{ updateRegistration(); });

function updateRegistration() {
    RNAcousticMobilePush.registrationDetails().then((registrationDetails) => {
        const registration = {userId: registrationDetails.userId, channelId: registrationDetails.channelId, appKey: RNAcousticMobilePush.appKey};
        // Send registration details to server here
    });
}

When using Cordova, you can get the registration details using the following methods:

1. Subscribe to delegate methods by specifying a method to be called or a block of code to be executed. You can subscribe to changes in registration by using the following code:
   JavaScript

   
   MCEPlugin.getRegistrationDetails(function(details) {
       if (typeof details.userId == "undefined" || typeof details.channelId == "undefined") {
           // Not yet registered, no user/channel
       }
       console.log("UserId is " + details.userId);
       console.log("ChannelId is " + details.channelId);
   });
   
   MCEPlugin.getAppKey(function(appKey) {
       console.log("AppKey is " + appKey);
   } 
   

2. If you want to obtain the registration details and send it to your server, do it in the MCEPlugin.setRegistrationCallback(function(details) mechanism.

You can get the registration details using the following methods:

1. Add the necessary imports.

import 'package:flutter/material.dart';
import 'package:flutter_acoustic_mobile_push/flutter_acoustic_sdk_push.dart';

2. Create and add the following variables and function to get the registration details.

// Create the following variables

var _userId = "";
var _channelId = "";
var _appKey = "";

// Add the following function

Future<void> getDataFromSDK() async {
   var value = RegisiterValue();
   value.getRegisterValue();
   value.userId.subscribe((args) {
     var data = args!.changedValue;
     setState(() {
       _userId = data;
     });
   });
 
   value.channelId.subscribe((args) {
     var data = args!.changedValue;
     setState(() {
       _channelId = data;
     });
   });
 
   value.appKey.subscribe((args) {
     var data = args!.changedValue;
     setState(() {
       _appKey = data;
     });
   });
 }

3. Whenever you need registration details call the getDataFromSDK function.