НЕ АКТУАЛЬНО

Актуальный репозиторий: https://gitlab.com/fruktorum/android/devino/DevinoPushV1-AndroidSDK

Devino SDK

Devino SDK has a functionality to handle push notifications

Integration via AAR file

1. Download latest library *.aar file from repository.
2. Put aar file into your project libs folder
3. In your module-level build.gradle add the following line

implementation files('libs/push-android-sdk-release-<VERSION>.aar')

where libs/push-android-sdk-release-.aar - path for sdk library

4. Add to you proguard-rules.pro:

-keepattributes Signature, InnerClasses, EnclosingMethod
-keepattributes RuntimeVisibleAnnotations, RuntimeVisibleParameterAnnotations
-keepclassmembers,allowshrinking,allowobfuscation interface * {
    @retrofit2.http.* <methods>;
}
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
-dontwarn javax.annotation.**

-if interface * { @retrofit2.http.* <methods>; }
-keep,allowobfuscation interface <1>

-keepclassmembers enum * { *; }
-keep class com.google.android.gms.location.** { *; }
-keep class com.devinotele.devinosdk.sdk.DevinoSdkPushService$PushButton { *; }

Implementation

To make things work you need Firebase in your application.

If you don't have it already, start from here:

• General Firebase Setup
• Firebase Cloud Messaging Setup

Once you have firebase set up, instantiate library with a builder. In our example app we do it in Application class

public class DevinoExampleApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        FirebaseMessaging firebase = FirebaseMessaging.getInstance();
        
        String devinoSecretKey = "Secret Key";
        String appId = "Application ID";
        String appVersion = BuildConfig.VERSION_NAME;
        
        DevinoSdk.Builder builder = new DevinoSdk.Builder(this, devinoSecretKey, appId, appVersion, firebase);
        builder.build();
    }
}

Also you can override default push action scheme and host. If not redefined, "devino: //default-push-action" will be used.

DevinoSdk.getInstance().setDefaultDeepLinkAction("scheme", "host");

Also you can override default notification icon and icon color:

DevinoSdk.getInstance().setDefaultNotificationIcon(drawable);
DevinoSdk.getInstance().setDefaultNotificationIconColor(colorInt);

Icon must have alpha transparency.

Also you can adjust the sound for the notification:

DevinoSdk.getInstance().setCustomSound(Uri.parse(sound));
DevinoSdk.getInstance().useDefaultSound();

Get sdk logs

To subscribe for sdk logs create instance of DevinoLogsCallback this way:

DevinoLogsCallback logs = new DevinoLogsCallback() {
    @Override
    public void onMessageLogged(String sdkLogMessage) {
        System.out.println(sdkLogMessage);
    }
};

or this way:

DevinoLogsCallback logs = sdkLogMessage -> {
    System.out.println(sdkLogMessage);
};

then subscribe for updates:

DevinoSdk.getInstance().requestLogs(logs);

Don't forget to unsubscribe it, when you don't need it anymore:

DevinoSdk.getInstance().unsubscribeLogs();

Register/update user data

Update user data this way:

DevinoSdk.getInstance().register("+79998887766", "example@email.com");

Phone and email must be valid. Otherwise server will not accept it.

Send device geo information

You can ask sdk to collect user geo and send it to a server with a specified interval. Due to Android OS restrictions it is not guaranteed that this function always works on every device. Some devices may restrict scheduled background tasks. Single geo updates can be also rescheduled by OS ( some updates may come later than expected).

Be aware. Updates will stop if a device was rebooted. Geo updates need user permission to be granted. Sdk can help it as well.

Start geo updates calling

int intervalMinutes = 15;
DevinoSdk.getInstance().subscribeGeo(this, intervalMinutes);

Get foreground geo permission with:

int REQUEST_CODE_START_UPDATES = <SOME CODE>
DevinoSdk.getInstance().requestGeoPermission(this, REQUEST_CODE_START_UPDATES);

To handle permission dialog result override onRequestPermissionsResult() in your activity:

@Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        switch (requestCode) {
            case REQUEST_CODE_START_UPDATES: {
                if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                    logsCallback.onMessageLogged("GEO PERMISSION GRANTED");
                    //do what you need
                } else {
                    //PERMISSION DENIED
                }
            }
            break;
            ...

        }
    }

For Android 13+ you can get foreground geo permission together with notification permission with:

int REQUEST_CODE = <SOME CODE>
DevinoSdk.getInstance().requestGeoAndNotificationPermissions(this, REQUEST_CODE);

And also you can get background geo permission if need with:

int REQUEST_CODE = <SOME CODE>
DevinoSdk.getInstance().requestBackgroundGeoPermission(this, REQUEST_CODE);

Unsubscribe updates with

DevinoSdk.getInstance().unsubscribeGeo(context);

Notification permission for Android 13+

You can get notification permission with:

int REQUEST_CODE = <SOME CODE>
DevinoSdk.getInstance().requestGeoAndNotificationPermissions(this, REQUEST_CODE);

or

int REQUEST_CODE = <SOME CODE>
DevinoSdk.getInstance().requestNotificationPermission(this, REQUEST_CODE);

Report app started

Do it with:

DevinoSdk.getInstance().appStarted();

Send custom event

You can send any data like this:

DevinoSdk.getInstance()
    .sendEvent(
        "Event name", 
        new HashMap<String, Object>() {{
            put("Foo", "Bar");
        }});

Report push status

When devino push is received, opened or canceled you can send a report on that. It is highly recommended that you use sdk constants for message status:

DevinoSdk.getInstance().pushEvent(pushId, DevinoSdk.PushStatus.DELIVERED, null);

Change notification subscription

True by default:

DevinoSdk.getInstance().activateSubscription(true);

Check notification subscription status

Use rxJava and get subscription status in success json { "result": boolean }

DevinoSdk.getInstance().checkSubscription()
    .subscribe(
        json -> //do what you need,
        throwable -> //do what you need
    )

Basic address of the API

The method allows you to set the new basic address of the API:

DevinoSdk.getInstance().updateBaseApiUrl(newBaseApiUrl, context);

Notifications

Notifications are received by the incoming notification processing service DevinoSdkPushService. It extends the Firebase Messaging Service and is designed to receive and process incoming messages and then generate push notifications. The data in the incoming message is transmitted in the format Map<String, String>. The service tracks the following fields:

Field name	Description	Required
pushId	Notification identification number	yes
title	Notification title	yes
body	Notification text body	yes
sound	Notification sound	no
image	Link to the image to download and further display in the notification	no
iconColor	Notification icon color	no
smallIcon	The name of the icon added in the application to be displayed in the notification	no
action	Notification click deeplink	no
silentPush	Silent Push: true\false	no
buttons	A string in Json format with a description of the buttons	no
customData	A string in Json format with a custom data	no

Button description format:

Field name	Description	Required
text	Button text	no
deeplink	Button click deeplink	no

Custom data description format:

Field name	Description	Required
login	Login string	no