Android SDK Reference

//This will enable the debug mode.
PushAlert.enableDebug(true);

//This will enable the debug mode.
PushAlert.enableDebug(true)

import co.pushalert.PushAlert;
import android.os.Build;

public class MyApplication extends Application {

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

        // PushAlert Initialization, you can get App ID from PushAlert Dashboard, Settings->App
        PushAlert.init("PUSHALERT_APP_ID", getApplicationContext());
    }
}

//Setting default accent color
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .setDefaultAccentColor(R.color.accent_color);

//Setting default small icon for notification
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .setDefaultAccentColor(R.color.accent_color);

//Customizing 2-Step Opt-in
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .customizeTwoStep(new TwoStepHelper() {
            @Override
            public void setValues() {
                title = "Want to stay Updated?";
                titleTextColor = R.color.title_color;

                subTitle = "Enable notification to get important updates instantly";
                subTitleTextColor = R.color.sub_title_color;

                acceptBtn = "Yes";
                acceptBtnTextColor = R.color.accept_btn_color;
                acceptBtnBgColor = R.color.accept_btn_bg_color;

                rejcectBtn = "No";
                rejcectBtnTextColor = R.color.reject_btn_color;
                rejcectBtnBgColor = R.color.reject_btn_bg_color;

                iconDrawable = R.drawable.notification_icon;
                imageDrawable = R.drawable.notification_image;
            }
        });

//Setting in-app behaviour (when app in focus) of notifications
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .setInAppNotificationBehaviour(PushAlert.PAInAppBehaviour.NOTIFICATION);

//Setting in-app behaviour (when app in focus) of notifications
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .setNotificationOpener(new NotificationOpener() {
            @Override
            public void notificationOpened(PANotificationOpened paNotificationOpened) {
                int notification_id = paNotificationOpened.getNotificationId();
                String action_id = paNotificationOpened.getActionId();
                String url = paNotificationOpened.getUrl();
                JSONObject extras = paNotificationOpened.getExtraData();

                //Use above data to open particular part of the app
                //Use action_id (clicked action button) to perform particular action like adding to cart, favourite, like, dislike
            }
        });

//Setting in-app behaviour (when app in focus) of notifications
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .setNotificationReceiver(new NotificationReceiver() {
            @Override
            public boolean notificationReceived() {
                PANotification paNotification = getPANotification();
                //Use PANotification object to get all properties of the notification like getShortTitle, getContent(), getImage() etc
                //These properties can be modified here

                //Return true if you handled the notification and don't want to PushAlert to show notification in the shade
                return false;
            }
        });

//Setting onSubscribeListener to get subscriber id on subscribe.
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .setOnSubscribeListener(new PASubscribe() {
            @Override
            public void onSubscribe(String s) {
                //Save subscriber id s as per your logic
            }
        });

//Setting to unsubscribe if users blocks notification in app settings.
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .unsubscribeWhenNotificationsAreDisabled(true);

//Setting consent required to push notification.
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .setRequiresPrivacyConsent(true);

//To enable tracking of your campaign in Google Analytics.
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .enableFirebaseEventReporting(true);

//Enabling sharing location data to target user based on longitude and latitude.
PushAlert.init("PUSHALERT_APP_ID", getApplicationContext())
         .enableLocationSharing(true);

//Setting unique ID to a subscriber
PushAlert.associateID("UNIQUE_ID");

//Setting unique ID to a subscriber
PushAlert.setEmail("someone@korner.space");

//Setting first name of the subscriber
PushAlert.setFirstName("Alex");

//Setting last name of the subscriber
PushAlert.setLastName("Jones");

//Setting gender of the subscriber
PushAlert.setGender("male");

//Setting age of the subscriber
PushAlert.setAge(29);

//Setting phone number of the subscriber
PushAlert.setPhoneNum("(000) 000-0000");

//Add a subscriber to a segment
PushAlert.addUserToSegment(12404);

//Remove a subscriber from a segment
PushAlert.removeUserFromSegment(12404);

//Adding attributes to a subscriber
Map<String, String> attr = new HashMap<>();
attr.put("language", "es");
attr.put("zip_code", "98125");
PushAlert.addAttributes(attr);

//Trigger events
PushAlert.triggerEvent("videos", "play", "video_id", 132);
PushAlert.triggerEvent("pdf", "download", "Top Marketing Strategies");

//Updating cart information for abandoned cart notifications, this can be called whenever there are changes in cart
Map<String, String> data = new HashMap<>();
data.put("customer_name", "Alex");
data.put("image", "https://cdn.pushalert.co/large-image/image9-16_test.png");
data.put("total_items", "3");
data.put("total_amount", "12.99");
data.put("cart_url", "https://korner.space/blog/cart/");
data.put("checkout_url", "https://korner.space/blog/checkout/");

PushAlert.processAbandonedCart(PushAlert.AbandonedCartAction.UPDATE, data);


//Deleting cart information to remove abandoned cart notifications from the queue, you can call this on order completion or when cart is emptied.
PushAlert.processAbandonedCart(PushAlert.AbandonedCartAction.DELETE, null);

//Adding in-stock alert for a subscriber
Map<String, String> map = new HashMap<>();
map.put("name", "Alex");

PushAlert.addOutOfStockAlert(2432, 1, 19.99, map);

//Checking out of stock alert is enabled for a given variant of the product.
boolean isEnabled = PushAlert.isOutOfStockEnabled(2432, 1);

//Removing out of stock alert for a given variant of the product.
PushAlert.removeOutOfStockAlert(2432, 1);

//Adding price drop alert for a subscriber
Map<String, String> map = new HashMap<>();
map.put("name", "Alex");

PushAlert.addPriceDropAlert(2432, 1, 19.99, map);

//Checking price drop alert is enabled for a given variant of the product.
boolean isEnabled = PushAlert.isPriceDropEnabled(2432, 1);

//Removing price drop alert for a given variant of the product.
PushAlert.removePriceDropAlert(2432, 1);

//Setting true after getting user consent.
PushAlert.setUserPrivacyConsent(true);

//Checking user consent to allow notification.
boolean userConsent = PushAlert.getUserPrivacyConsent();

//Checking consent required or not.
boolean requiresConsent = PushAlert.getRequiresPrivacyConsent();

//Getting PushAlert subscriber ID.
String subs_id = PushAlert.getSubscriberID();

//Checking push subscription status.
boolean isUserSubscribed = PushAlert.isUserSubscribed();

//Disable notification for the subscriber.
PushAlert.disableNotification(true);

//Checking notification status.
boolean isNotificationDisabled = PushAlert.isNotificationDisabled();

//Reporting conversion without a value.
PushAlert.reportConversion('register');

//Reporting conversion with a value.
PushAlert.reportConversionWithValue('purchase', 12.99);

// Set Opt-in Mode for Android
// From Android 13 and above, request permission is required to send push notifications. We recommend TWO_STEP opt-in mode for Android 13 and above; otherwise AUTO opt-in mode.
if (Build.VERSION.SDK_INT >= 33){
    PushAlert.setOptInMode(PushAlert.PAOptInMode.TWO_STEP);
}
else{
    PushAlert.setOptInMode(PushAlert.PAOptInMode.AUTO);
}

//Initialising push subscription manually
PushAlert.requestForPushNotificationPermission(true);