SDK API

              /**
     * Set heartbeat interval
     *
     * You need to call in the Application.onCreate() method
     *
     * @param context is not empty
     * @param heartbeatInterval The time unit is milliseconds. It must be greater than 0. The default value is 4 minutes and 50 seconds.
     */
    public static void configHeartbeatInterval(Context context, long heartbeatInterval)

        

          MTCorePrivatesApi.configHeartbeatInterval(this,3 * 60 * 1000);

        

              /**
     *Set the number of long connection retries
     *
     * You need to call in the Application.onCreate() method
     *
     * @param context is not empty
     * @param connectRetryCount Number of retries. The default value is 3. At least 3 retries
     */
    public static void configConnectRetryCount(Context context, int connectRetryCount)

        

          MTCorePrivatesApi.configConnectRetryCount(this,10);

        

              /**
     * Set whether to debug mode, which will print more detailed logs
     *
     * You need to call in the Application.onCreate() method
     * 
     * @Param context is not empty
     * @param enable Whether to debug mode, true is the debug mode, false is not
     */
    public static void configDebugMode(Context context, boolean enable)

        

                  // It is recommended to set it to true when the application is not online for easy integration
        MTCorePrivatesApi.configDebugMode(context.getApplicationContext(), true);
        
        // It is recommended that the application be set to false after going online
        MTCorePrivatesApi.configDebugMode(context.getApplicationContext(), false);

        

              /**
     * Configure to use national security encryption
     *
     * @param context is not empty
     */
    public static void configSM4(Context context)

        

              // Enable national security encryption, and use the default encryption method if not called
    MTCorePrivatesApi.configSM4(context.getApplicationContext());

        

              /**
     * Get the userId of the current device, the unique ID of the Engagelab private cloud, which can be the same as push
     *
     * @param context is not empty
     * @return userId
     */
    public static String getUserId(Context context)

        

                  String userId = MTCorePrivatesApi.getUserId(context);

        

              /**
     * Get the registrationId of the current device, the unique ID of the Engagelab private cloud, which can be the same as push
     *
     * @param context is not empty
     * @return registrationId
     */
    public static String getRegistrationId(Context context)

        

          String registrationId = MTPushPrivatesApi.getRegistrationId(context);

        

              /**
     * Configure the push version as 3.9. X
     *
     * @param context is not empty
     */
    public static void configOldPushVersion(Context context)

        

          public class ExampleApplication extends Application {

    @Override
    public void onCreate() {
        // Turn on debug mode    
            MTCorePrivatesApi.configDebugMode(context.getApplicationContext(), true);
            // Click to jump using the old notification
            MTPushPrivatesApi.configOldPushVersion(context.getApplicationContext());
            // initialization
                MTPushPrivatesApi.init(context.getApplicationContext());   
    }
}

        

              /**
     * MTPush initialization
     *
     * It is recommended to call in the Application.onCreate() method
     * 
     * @param context is not empty, please use the applicationContext object
     */
    public static void init(Context context)

        

          public class ExampleApplication extends Application {

    @Override
    public void onCreate() {
        // Turn on debug mode    
            MTCorePrivatesApi.configDebugMode(context.getApplicationContext(), true);
            // initialization
                MTPushPrivatesApi.init(context.getApplicationContext());   
    }
}

        

              /**
     * Go to the notification switch setting page
     *
     * @param context not empty
     */
    public static void goToAppNotificationSettings(Context context)

        

              // Go to the notification switch setting page, and the customer needs to manually turn on the notification switch
    MTPushPrivatesApi.goToAppNotificationSettings(this);
    
    // After inheriting MTCommonReceiver, copy the onNotificationStatus method to obtain the status of the notification switch. If enable is true, it indicates that it has been successfully enabled
    @Override
    public void onNotificationStatus(Context context, boolean enable) {
                if(enable){
                        // The notification switch is set to ON
                }	    
    }

        

              /**
     * Enable Push, and the status of the persistent storage switch is true. The default is true
     * 
     * @param context not empty
     */
    public static void turnOnPush(Context context)

        

                  // Push is enabled by default
        MTPushPrivatesApi.turnOnPush(context);
        
        // After inheriting MTCommonReceiver, copy the onConnectStatus method to obtain the connection status of the long connection. If enable is true, it indicates that it has been successfully enabled
        @Override
        public void onConnectStatus(Context context, boolean enable){
                if(enable){
                        // Successfully enabled push
                }				
        }

        

              /**
     * Turn off push, and the persistent storage switch status is false. The default is true
     *
     * @param context not empty
     */
    public static void turnOffPush(Context context)

        

                  // Turn off push. You need to call turnOnPush again to turn on push
        MTPushPrivatesApi.turnOffPush(context);
        
        // After inheriting MTCommonReceiver, copy the onConnectStatus method to obtain the long connection status. If enable is false, it indicates that it has been closed successfully
        @Override
        public void onConnectStatus(Context context, boolean enable){
                if(!enable){
                        // Successfully closed push
                }
        }

        

              /**
     * Set the display time of the notice. It is displayed at any time by default
     *
     * @param context   not empty
     * @param beginHour Allow notification of the start time of the display (24-hour format, ranging from 0 to 23)
     * @param endHour   It is allowed to notify the end time of display (24-hour format, ranging from 0 to 23). beginHour cannot be greater than or equal to endHour
     * @param weekDays  An array of days (7-day system, ranging from 1 to 7) that allows notifications to be displayed. An empty array means that notifications will not be displayed at any time
     */
    public static void setNotificationShowTime(Context context, int beginHour, int endHour, int... weekDays)

        

              // Set the display time of the notice to be 9:00 a.m. to 9:00 p.m. on 1/3/5/7 every week
    MTPushPrivatesApi.setNotificationShowTime(context, 9, 21, 1,3,5,7);

        

              /**
     * Reset the display time of the notice, and display at any time by default
     *
     * @param context not empty
     */
    public static void resetNotificationShowTime(Context context)

        

              // Reset the display time of the notice, and display at any time by default
    MTPushPrivatesApi.resetNotificationShowTime(context);

        

              /**
     * Set the notification silence time. By default, no silence occurs at any time
     *
     * @param context     not empty
     * @param beginHour   The start time of the allowed notification silence, in hours (24-hour format, ranging from 0 to 23)
     * @param beginMinute The start time of the allowed notification silence, in minutes (60 minute format, ranging from 0 to 59)
     * @param endHour     The end time of the allowed notification silence, in hours (24-hour format, ranging from 0 to 23)
     * @param endMinute   The end time allowed for notification silence, in minutes (60 minute format, ranging from 0 to 59)
     */
    public static void setNotificationSilenceTime(Context context, int beginHour, int beginMinute, int endHour, int endMinute)

        

              // Set the notification silence time from 9:30 p.m. to 9:30 a.m
    MTPushPrivatesApi.setNotificationSilenceTime(context, 21, 30, 9, 30);

        

              /**
     * Reset the notification silence time. By default, no silence occurs at any time
     *
     * @param context not empty
     */
    public static void resetNotificationSilenceTime(Context context)

        

              // Reset the notification silence time. By default, no silence occurs at any time
    MTPushPrivatesApi.resetNotificationSilenceTime(context);

        

              /**
     * Set the custom notification layout, and use the system notification layout by default
     *
     * @param context            not empty
     * @param builderId          builder id
     * @param notificationLayout Objects that customize the notification layout，not empty
     */
    public static void setNotificationLayout(Context context, int builderId, NotificationLayout notificationLayout)

        

                  // A constant is defined here, representing the build id
        private static final int BUILDER_ID = 11;
        
        // build notificationLayout
    NotificationLayout notificationLayout = new NotificationLayout()
            .setLayoutId(R.layout.custom_notification_layout)        // layout_id
            .setIconViewId(R.id.iv_notification_icon)                // view_id
            .setIconResourceId(R.drawable.mtpush_notification_icon)   // source_id
            .setTitleViewId(R.id.tv_notification_title)              // view_id
            .setContentViewId(R.id.tv_notification_content)          // view_id
            .setTimeViewId(R.id.tv_notification_time);               // view_id
 
    // Set the build id to BUILDER_ The custom layout of ID, and the builderId is specified as BUILDER when the notification is issued_ ID, you can change the notification layout        
    MTPushPrivatesApi.setNotificationLayout(this.getApplicationContext(), BUILDER_ID, notificationLayout);

        

              /**
     * Reset custom notification layout, default to system notification layout
     *
     * @param context   not empty
     * @param builderId    ID of custom notification layout
     */
    public static void resetNotificationLayout(Context context, int builderId)

        

                  // A constant is defined here, representing the build id
        private static final int BUILDER_ID = 11;
        
    // Reset build id to BUILDER_ The custom layout of ID, and the builderId is specified as BUILDER when the notification is issued_ ID, the system default layout will be used
    MTPushPrivatesApi.resetNotificationLayout(context,BUILDER_ID);

        

              /**
     * Set the number of notifications in the notification bar. The default number is 5
     *
     * @param context not empty
     * @param count   Limit the number of notifications in the notification bar. If the number exceeds the limit, the oldest notification will be removed. It cannot be less than or equal to 0
     */
    public static void setNotificationCount(Context context, int count)

        

              // Set the number of notifications in the notification bar to 50
    MTPushPrivatesApi.setNotificationCount(context,50);

        

              /**
     * Reset the number of notifications in the notification bar. The default number is 5
     *
     * @param context not empty
     */
    public static void resetNotificationCount(Context context)

        

              // Reset the number of notifications in the notification bar. The default number is 5
    MTPushPrivatesApi.resetNotificationCount(context);

        

              /**
     * Set the number of application subscripts. The default is 0 (only effective for Huawei/Honour)
     *
     * @param context not empty
     * @param badge   Number of applied corner markers
     */
    public static void setNotificationBadge(Context context, int badge)

        

              // Set the number of applied subscripts to 1
    MTPushPrivatesApi.setNotificationBadge(context,1);

        

              /**
     * Set the number of application subscripts. The default is 0 (only effective for Huawei/Honour)
     *
     * @param context not empty
     */
    public static void resetNotificationBadge(Context context) {

        

              // Reset the number of applied subscripts. The default is 0
    MTPushPrivatesApi.resetNotificationBadge(context);

        

              /**
     * Display notice
     *
     * @param context             not empty
     * @param notificationMessage Notification object built，not empty
     */
    public static void showNotification(Context context, NotificationMessage notificationMessage)

        

              // Build a basic notification, where messageId and content are required, otherwise the notification cannot be displayed
    NotificationMessage notificationMessage = new NotificationMessage()
            .setMessageId("12345")
            .setNotificationId(12345)
            .setTitle("custom_notification_title")
            .setContent("custom_notification_content");    
    // Display notice
    MTPushPrivatesApi.showNotification(context,notificationMessage);

        

              /**
     * Clear notification of the specified notifyId
     *
     * @param context  not empty
     * @param notifyId notice id
     */
    public static void clearNotification(Context context, int notifyId)

        

              // Clear notification of the specified notifyId
    MTPushPrivatesApi.clearNotification(context,12345);

        

              /**
     * Report the arrival of manufacturer channel notification
     * 
     * Report via http/https
     *
     * @param context           not empty
     * @param messageId         Engagelab message id，not empty
     * @param platform          platform，value（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param platformMessageId platform id，can be empty
     */
    public static void reportNotificationArrived(Context context, String messageId, byte platform, String platformMessageId)

        

              // Report the arrival of the manufacturer's notification, the messageId is "12345", the manufacturer is Xiaomi, and the manufacturer's messageId is "MI-6476RHT25"
    MTPushPrivatesApi.reportNotificationArrived(context,“12345”,MTPushPrivatesApi.PLATFORM_XIAOMI,"MI-6476RHT25");

        

              /**
     * Submit the manufacturer channel notification and click
* 
     *Report via http/https
     *
     * @param context           not empty
     * @param messageId         Engagelab message id，not empty
     * @param platform          platform，value（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param platformMessageId platform message id，can be empty
     */
    public static void reportNotificationClicked(Context context, String messageId, byte platform, String platformMessageId)

        

              // Click to report the manufacturer's notice. The messageId is "12345", the manufacturer is Xiaomi, and the manufacturer's messageId is "MI-6476RHT25"
    MTPushPrivatesApi.reportNotificationClicked(context,“12345”,MTPushPrivatesApi.PLATFORM_XIAOMI,"MI-6476RHT25");

        

              /**
     * Report to manufacturer channel notification deletion
     * 
     * Report via http/https
     *
     * @param context           not empty
     * @param messageId         Engagelab message id，not empty
     * @param platform          platform，value（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param platformMessageId platform message id，can be empty
     */
    public static void reportNotificationDeleted(Context context, String messageId, byte platform, String platformMessageId)

        

              // Report the deletion of the vendor notification. The messageId is "12345", the vendor is mi, and the vendor messageId is "MI-6476RHT25"
    MTPushPrivatesApi.reportNotificationDeleted(context,“12345”,MTPushPrivatesApi.PLATFORM_XIAOMI,"MI-6476RHT25");

        

              /**
     * Open the channel notification of the reported manufacturer
* 
     *Report via http/https
     *
     * @param context           not empty
     * @param messageId         Engagelab message id，not empty
     * @param platform          platform，value（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param platformMessageId platform message id，can be empty
     */
    public static void reportNotificationOpened(Context context, String messageId, byte platform, String platformMessageId)

        

              Bundle bundle = intent.getExtras();
    String platformMessage = "";
    // huawei
    if (intent.getData() != null) {
        platformMessage = intent.getData().toString();
    }
    // Other Mobile manufacturers
    if (TextUtils.isEmpty(platformMessage) && intent.getExtras() != null) {
        if (MTGlobal.IS_FOR_JIGUANG) {
             platformMessage = bundle.getString("JMessageExtra");
        }else {
             platformMessage = bundle.getString("MTMessageExtra");
        }
    }
    if (TextUtils.isEmpty(platformMessage)) {
        return;
    }
    JSONObject messageJson = new JSONObject(platformMessage);
    tvMessage.setText(toLogString(messageJson));
    // analysis
    String messageId = messageJson.optString("msg_id");
    byte platform = (byte) messageJson.optInt("rom_type");
    String title = messageJson.optString("n_title");
    String content = messageJson.optString("n_content");
    // Click activity to open the report notification. We recommend that you add all vendor redirects. Only MTPush4.0.0 or later is required.
    MTPushPrivatesApi.reportNotificationOpened(this, messageId, platform, "");

        

              /**
     * upload Manufacturer token
     * 
     * upload via tcp
     *
     * @param context  not empty
     * @param platform mobile manufacturer，ranges from（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param token    token back from mobile manufacturer，not empty
     * @param region Overseas versions of Xiaomi and oppo need to set the region, fill in such as "US" according to the region of use, etc., fill in null for non-overseas versions
     */
    public static void uploadPlatformToken(Context context, byte platform, String token, String region)

        

              // Report the manufacturer token. The manufacturer is mi and the manufacturer token is “MI-6476s-afs-afs-afaR-HT25”
    MTPushPrivatesApi.uploadPlatformToken(context,MTPushPrivatesApi.PLATFORM_XIAOMI,"MI-6476s-afs-afs-afaR-HT25","US");

        

              /**
     * Application notification switch status callback
     *
     * @param context not empty
     * @param enable  Is the notification switch on? true means yes，false means no
     */
    @Override
    public void onNotificationStatus(Context context, boolean enable)

        

              /**
     * persistent connection success
     *
     * After initialization, the connection is initiated. If the connection succeeds or fails, a callback is returned.
     *
     * @param context not empty
     * @param enable  Is the persistent connection successful? true means yes，false means no   
     */		
        public void onConnectStatus(Context context, boolean enable)

        

              /**
     * Notification message delivery
     *
     * This method is called back when a pushed notification message is delivered
     *
     * @param context 						not empty
     * @param notificationMessage Notification message  
     */				
        public void onNotificationArrived(Context context, NotificationMessage notificationMessage)

        

              /**
     * Notification message click
     *
         * This method is called back when a pushed notification message is clicked
         *
     * @param context 						not empty
     * @param notificationMessage Notification message  
     */				
        public void onNotificationClicked(Context context, NotificationMessage notificationMessage)

        

              /**
     * Notification message deletion
     * 
         * This method is called back when the pushed notification message is deleted
         *
     * @param context 						not empty
     * @param notificationMessage Notification message  
     */				
        public void onNotificationDeleted(Context context, NotificationMessage notificationMessage)

        

              /**
     * Custom message delivery
     *
     * This method is called back when a custom message is sent
     *
     * @param context 			not empty
     * @param customMessage Custom message  
     */				
        public void onCustomMessage(Context context, CustomMessage customMessage)

        

              /**
     * Manufacturer operation message
     *
     * @param context         ApplicationContext Object
     * @param platformTokenMessage   manufacturer token message
     */
    public void onPlatformToken(Context context, PlatformTokenMessage platformMessage)