SDK API

              /**
     * 配置應用key，不使用AndroidManifest.xml中的配置
     *
     * 需要在Application.onCreate()方法中調用
     * 請在[init](#init)之前調用
     *
     * @param context 不為空
     * @param appKey 不為空
     */
    public static void configAppKey(Context context, String appKey)

        

          MTCorePrivatesApi.configAppKey(this,"你的appkey");

        

               /**
         * 配置應用管道，不使用AndroidManifest.xml中的配置
         * 需要在Application.onCreate()方法中調用
         * 需在init前，並要在Application.onCreate內使用
         *
         * @param context    不為空
         * @param appChannel 不為空
         */
    public static void configAppChannel(Context context, String appChannel)

        

          MTCorePrivatesApi.configAppChannel(this,"你的appChannel");

        

              /**
     * 配置數據中心站點名稱，不使用AndroidManifest.xml中的配置
     * 目前可選的節點有Singapore、USA_Virginia、DEU_Frankfurt和HongKong。
     * 需要在Application.onCreate()方法中調用
     * 請在[init](#init)之前調用
     *
     * @param context 不為空
     * @param appSiteName 不為空
     */
    public static void configAppSiteName(Context context, String appSiteName)

        

          MTCorePrivatesApi.configAppSiteName(this,"你的平台數據中心站點名稱");

        

              /**
     * 設置心跳時間間隔
     *
     * 需要在 Application.onCreate() 方法中調用
     *
     * @param context 不為空
     * @param heartbeatInterval 時間單位為毫秒、必須大於 0、默認值是 4 分 50 秒 \
     */
    public static void configHeartbeatInterval(Context context, long heartbeatInterval)

        

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

        

              /**
     * 設置長連接重試次數
     *
     * 需要在 Application.onCreate() 方法中調用
     *
     * @param context 不為空
     * @param connectRetryCount 重試的次數、默認值為 3、最少 3 次
     */
    public static void configConnectRetryCount(Context context, int connectRetryCount)

        

          MTCorePrivatesApi.configConnectRetryCount(this,10);

        

              /**
     * 设置长连接是否加密，默认不加密
     *
     * 需要在Application.onCreate()方法中调用
     *
     * @param isSSL true加密，false不加密
     */
    public static void setTcpSSl(Context context, boolean isSSL)

        

          MTCorePrivatesApi.setTcpSSl(context,true);

        

              /**
     * 設置是否 debug 模式，debug 模式會打印更對詳細日誌
     *
     * 需要在 Application.onCreate() 方法中調用
     * 
     * @param context 不為空 
     * @param enable 是否調試模式，true 為調試模式，false 不是
     */
    public static void configDebugMode(Context context, boolean enable)

        

                  // 建議應用程式未上線時設置為 true，方便集成
        MTCorePrivatesApi.configDebugMode(context.getApplicationContext(), true);
        
        // 建議應用程式上線後設置為 false
        MTCorePrivatesApi.configDebugMode(context.getApplicationContext(), false);

        

              /**
     * 配置使用國密加密
     *
     * @param context 不為空
     */
    public static void configSM4(Context context)

        

              // 開啟國密加密，不調用則使用默認加密方式
    MTCorePrivatesApi.configSM4(context.getApplicationContext());

        

              /**
     * 獲取當前設備的 userId，Engagelab 私有云唯一標識，可同於推播
     *
     * @param context 不為空
     * @return userId
     */
    public static String getUserId(Context context)

        

                  String userId = MTCorePrivatesApi.getUserId(context);

        

              /**
     * 獲取當前設備的 registrationId，Engagelab 私有云唯一標識，可同於推播
     *
     * @param context 不為空
     * @return registrationId
     */
    public static String getRegistrationId(Context context)

        

                  String registrationId = MTPushPrivatesApi.getRegistrationId(context);

        

              /**
     * 配置 push 版本號為 3.9.X
     *
     * @param context 不為空
     */
    public static void configOldPushVersion(Context context)

        

          public class ExampleApplication extends Application {

    @Override
    public void onCreate() {
        // 打開調試模式    
            MTCorePrivatesApi.configDebugMode(context.getApplicationContext(), true);
            // 使用老版本的通知點擊跳轉
            MTPushPrivatesApi.configOldPushVersion(context.getApplicationContext());
            // 初始化
                MTPushPrivatesApi.init(context.getApplicationContext());   
    }
}

        

              /**
     * 語音播報功能設置，需要導入語音包(mt-sdk-sound-x.x.x.aar)
     *
     * @param context      不為空
     * @param enable true為打開，false為關閉，默認為false
     */
    public static void setEnablePushTextToSpeech(Context context, boolean enable)

        

              MTPushPrivatesApi.setEnablePushTextToSpeech(context,true);   

        

              /**
     * MTPush 初始化
     *
     * 建議在 Application.onCreate() 方法中調用
     * 
     * @param context 不為空，請使用 applicationContext 對象
     */
    public static void init(Context context)

        

          public class ExampleApplication extends Application {

    @Override
    public void onCreate() {
        // 打開調試模式    
            MTCorePrivatesApi.configDebugMode(context.getApplicationContext(), true);
            // 初始化
                MTPushPrivatesApi.init(context.getApplicationContext());   
    }
}

        

              /**
     * 前往通知開關設置頁面
     *
     * @param context 不為空
     */
    public static void goToAppNotificationSettings(Context context)

        

              // 前往通知開關設置頁面，需要客戶手動打開通知開關
    MTPushPrivatesApi.goToAppNotificationSettings(this);
    
    // 繼承 MTCommonReceiver 後，複寫 onNotificationStatus 方法，獲取通知開關狀態，如果 enable 為 true 說明已經開啟成功
    @Override
    public void onNotificationStatus(Context context, boolean enable) {if(enable){// 已設置通知開關為打開}	    
    }

        

              /**
     * 開啟 Push 推播，並持久化存儲開關狀態為 true，默認是 true
     * 
     * @param context 不能為空
     */
    public static void turnOnPush(Context context)

        

                  // 開啟推播，默認就是打開的
        MTPushPrivatesApi.turnOnPush(context);
        
        // 繼承 MTCommonReceiver 後，複寫 onConnectStatus 方法，獲取長連接的連接狀態，如果 enable 為 true 說明已經開啟成功
        @Override
        public void onConnectStatus(Context context, boolean enable){if(enable){// 開啟 push 推播成功}				
        }

        

              /**
     * 關閉 push 推播，並持久化存儲開關狀態為 false，默認是 true
     *
     * @param context 不能為空
     */
    public static void turnOffPush(Context context)

        

                  // 關閉推播，需要再調用 turnOnPush 才能開啟推播
        MTPushPrivatesApi.turnOffPush(context);
        
        // 繼承 MTCommonReceiver 後，複寫 onConnectStatus 方法，獲取長連接狀態，如果 enable 為 false 說明已經關閉成功
        @Override
        public void onConnectStatus(Context context, boolean enable){if(!enable){// 關閉 push 推播成功}
        }

        

              /**
     * 設置通知展示時間，默認任何時間都展示
     *
     * @param context   不為空
     * @param beginHour 允許通知展示的開始時間（ 24 小時制，範圍為 0 到 23 ）
     * @param endHour   允許通知展示的結束時間（ 24 小時制，範圍為 0 到 23 ），beginHour 不能大於等於 endHour
     * @param weekDays  允許通知展示的星期數組（ 7 日制，範圍為 1 到 7），空數組代表任何時候都不展示通知
     */
    public static void setNotificationShowTime(Context context, int beginHour, int endHour, int... weekDays)

        

              // 設置通知展示時間為每週 1/3/5/7 的早上 9 點到晚上 9 點
    MTPushPrivatesApi.setNotificationShowTime(context, 9, 21, 1,3,5,7);

        

              /**
     * 重置通知展示時間，默認任何時間都展示
     *
     * @param context 不為空
     */
    public static void resetNotificationShowTime(Context context)

        

              // 重置通知展示時間，默認任何時間都展示
    MTPushPrivatesApi.resetNotificationShowTime(context);

        

              /**
     * 設置通知靜默時間，默認任何時間都不靜默
     *
     * @param context     不為空
     * @param beginHour   允許通知靜默的開始時間，單位小時（ 24 小時制，範圍為 0 到 23 ）
     * @param beginMinute 允許通知靜默的開始時間，單位分鐘（ 60 分鐘制，範圍為 0 到 59 ）
     * @param endHour     允許通知靜默的結束時間，單位小時（ 24 小時制，範圍為 0 到 23 ）
     * @param endMinute   允許通知靜默的結束時間，單位分鐘（ 60 分鐘制，範圍為 0 到 59 ）
     */
    public static void setNotificationSilenceTime(Context context, int beginHour, int beginMinute, int endHour, int endMinute)

        

              // 設置通知靜默時間為每天晚上 9 點半到第二天早上 9 點半
    MTPushPrivatesApi.setNotificationSilenceTime(context, 21, 30, 9, 30);

        

              /**
     * 重置通知靜默時間，默認任何時間都不靜默
     *
     * @param context 不為空
     */
    public static void resetNotificationSilenceTime(Context context)

        

              // 重置通知靜默時間，默認任何時間都不靜默
    MTPushPrivatesApi.resetNotificationSilenceTime(context);

        

              /**
     * 設置自訂通知佈局，默認使用系統通知佈局
     *
     * @param context            不為空
     * @param builderId          構建 id
     * @param notificationLayout 自訂通知佈局的對象，不為空
     */
    public static void setNotificationLayout(Context context, int builderId, NotificationLayout notificationLayout)

        

                  // 這裡定義一個常量，代表構建 id
        private static final int BUILDER_ID = 11;
        
        // 構建出一個 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
 
    // 設置構建 id 為 BUILDER_ID 的自訂佈局，傳送通知時指定 builderId 為 BUILDER_ID，即可改變通知佈局        
    MTPushPrivatesApi.setNotificationLayout(this.getApplicationContext(), BUILDER_ID, notificationLayout);

        

              /**
     * 重置自訂通知佈局，默認使用系統通知佈局
     *
     * @param context   不為空
     * @param builderId 自訂通知佈局的 id
     */
    public static void resetNotificationLayout(Context context, int builderId)

        

                  // 這裡定義一個常量，代表構建 id
        private static final int BUILDER_ID = 11;
        
    // 重置構建 id 為 BUILDER_ID 的自訂佈局，傳送通知時指定 builderId 為 BUILDER_ID，將使用系統默認佈局
    MTPushPrivatesApi.resetNotificationLayout(context,BUILDER_ID);

        

              /**
     * 設置通知欄的通知數量，默認數量為 5
     *
     * @param context 不為空
     * @param count   限制通知欄的通知數量，超出限制數量則移除最老通知，不能小於等於 0
     */
    public static void setNotificationCount(Context context, int count)

        

              // 設置通知欄通知數量為 50
    MTPushPrivatesApi.setNotificationCount(context,50);

        

              /**
     * 重置通知欄的通知數量，默認數量為 5
     *
     * @param context 不為空
     */
    public static void resetNotificationCount(Context context)

        

              // 重置通知欄的通知數量，默認數量為 5
    MTPushPrivatesApi.resetNotificationCount(context);

        

              /**
     * 設置應用程式角標數量，默認 0（僅華為 / 榮耀生效）
     *
     * @param context 不為空
     * @param badge   應用程式角標數量
     */
    public static void setNotificationBadge(Context context, int badge)

        

              // 設置應用程式角標數量為 1
    MTPushPrivatesApi.setNotificationBadge(context,1);

        

              /**
     * 重置應用程式角標數量，默認 0（僅華為 / 榮耀生效）
     *
     * @param context 不為空
     */
    public static void resetNotificationBadge(Context context) {

        

              // 重置應用程式角標數量，默認 0
    MTPushPrivatesApi.resetNotificationBadge(context);

        

              /**
     * 展示通知
     *
     * @param context             不為空
     * @param notificationMessage 構建的通知對象，不為空
     */
    public static void showNotification(Context context, NotificationMessage notificationMessage)

        

              // 構建一個基礎的通知，其中 messageId 和 content 是必須，否則通知無法展示
    NotificationMessage notificationMessage = new NotificationMessage().setMessageId("12345")
            .setNotificationId(12345)
            .setTitle("custom_notification_title")
            .setContent("custom_notification_content");    
    // 展示通知
    MTPushPrivatesApi.showNotification(context,notificationMessage);

        

              /**
     * 清除指定 notifyId 的通知
     *
     * @param context  不為空
     * @param notifyId 通知 id
     */
    public static void clearNotification(Context context, int notifyId)

        

              // 清除指定 notifyId 的通知
    MTPushPrivatesApi.clearNotification(context,12345);

        

              /**
     * 上報廠商通道通知到達
     * 
     * 走 http/https 上報
     *
     * @param context           不為空
     * @param messageId         Engagelab 訊息 id，不為空
     * @param platform          廠商，取值範圍（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param platformMessageId 廠商訊息 id，可為空
     */
    public static void reportNotificationArrived(Context context, String messageId, byte platform, String platformMessageId)

        

              // 上報廠商通知到達，messageId 為“12345”，廠商為小米，廠商 messageId 為“MI-6476RHT25”
    MTPushPrivatesApi.reportNotificationArrived(context,“12345”,MTPushPrivatesApi.PLATFORM_XIAOMI,"MI-6476RHT25");

        

              /**
     * 上報廠商通道通知點擊
     * 
     * 走 http/https 上報
     *
     * @param context           不為空
     * @param messageId         Engagelab 訊息 id，不為空
     * @param platform          廠商，取值範圍（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param platformMessageId 廠商訊息 id，可為空
     */
    public static void reportNotificationClicked(Context context, String messageId, byte platform, String platformMessageId)

        

              // 上報廠商通知點擊，messageId 為“12345”，廠商為小米，廠商 messageId 為“MI-6476RHT25”
    MTPushPrivatesApi.reportNotificationClicked(context,“12345”,MTPushPrivatesApi.PLATFORM_XIAOMI,"MI-6476RHT25");

        

              /**
     * 上報廠商通道通知刪除
     * 
     * 走 http/https 上報
     *
     * @param context           不為空
     * @param messageId         Engagelab 訊息 id，不為空
     * @param platform          廠商，取值範圍（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param platformMessageId 廠商訊息 id，可為空
     */
    public static void reportNotificationDeleted(Context context, String messageId, byte platform, String platformMessageId)

        

              // 上報廠商通知刪除，messageId 為“12345”，廠商為 mi，廠商 messageId 為“MI-6476RHT25”
    MTPushPrivatesApi.reportNotificationDeleted(context,“12345”,MTPushPrivatesApi.PLATFORM_XIAOMI,"MI-6476RHT25");

        

              /**
     * 上報廠商通道通知打開
     * 
     * 走 http/https 上報
     *
     * @param context           不為空
     * @param messageId         Engagelab 訊息 id，不為空
     * @param platform          廠商，取值範圍（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param platformMessageId 廠商訊息 id，可為空
     */
    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();}
    // 其他廠商
    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));
    // 解析
    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");
    // 上報通知點擊 activity 打開，建議所有廠商跳轉都加上，僅 MTPush4.0.0 以下版本需要
    MTPushPrivatesApi.reportNotificationOpened(this, messageId, platform, "");

        

              /**
     * 上傳廠商 token
     * 
     * 走 tcp 上傳
     *
     * @param context  不為空
     * @param platform 廠商，取值範圍（1:mi、2:huawei、3:meizu、4:oppo、5:vivo、8:google）
     * @param token    廠商返回的 token，不為空
     * @param region    海外版小米和oppo需要设置region，国际版填:"GLOBAL",非海外版的填:"NULL"
     */
    public static void uploadPlatformToken(Context context, byte platform, String token, String region)

        

              // 上报厂商token，厂商为mi，厂商token为“MI-6476s-afs-afs-afaR-HT25”
    MTPushPrivatesApi.uploadPlatformToken(context,MTPushPrivatesApi.PLATFORM_XIAOMI,"MI-6476s-afs-afs-afaR-HT25","NULL");

        

          /**
 * @param context           不為空
 * @param fragmentName      Fragment頁面完整類名（this.getClass().getCanonicalName()）
 */
public static void onFragmentResume(Context context, String fragmentName)

        

          /**
 * @param context           不為空
 * @param fragmentName      Fragment頁面完整類名（this.getClass().getCanonicalName()）
 */
public static void onFragmentPause(Context context, String fragmentName)

        

              /**
     * 應用程式通知開關狀態回調
     *
     * @param context 不為空
     * @param enable  通知開關是否開，true 為打開，false 為關閉
     */
    @Override
    public void onNotificationStatus(Context context, boolean enable)

        

              /**
     * 長連接是否連接成功
     *
     * 在初始化後會進行長連接，連接成功 / 失敗均會回調此方法
     *
     * @param context 不為空
     * @param enable  長連接是否連接成功，true 為成功；false 為失敗   
     */		
        public void onConnectStatus(Context context, boolean enable)

        

              /**
     * 通知訊息送達
     *
     * 推播的通知訊息送達會回調此方法
     *
     * @param context 						不為空
     * @param notificationMessage 通知訊息  
     */				
        public void onNotificationArrived(Context context, NotificationMessage notificationMessage)

        

              /**
     * 通知消息在前台不顯示
     *
     * @param context             不為空
     * @param notificationMessage 通知消息
     */
    @Override
    public void onNotificationUnShow(Context context, NotificationMessage notificationMessage)

        

              /**
     * 通知訊息點擊
     *
         * 推播的通知訊息點擊會回調此方法
         *
     * @param context 						不為空
     * @param notificationMessage 通知訊息  
     */				
        public void onNotificationClicked(Context context, NotificationMessage notificationMessage)

        

              /**
     * 通知訊息刪除
     * 
         * 推播的通知訊息刪除會回調此方法
         *
     * @param context 						不為空
     * @param notificationMessage 通知訊息  
     */				
        public void onNotificationDeleted(Context context, NotificationMessage notificationMessage)

        

              /**
     * 自訂訊息送達
     *
     * 自訂訊息送達時會回調此方法
     *
     * @param context 			不為空
     * @param customMessage 自訂訊息  
     */				
        public void onCustomMessage(Context context, CustomMessage customMessage)

        

              /**
     * 廠商操作消息
     *
     * @param context         ApplicationContext對象
     * @param platformMessage 廠商token消息
     */
    public void onPlatformToken(Context context, PlatformTokenMessage platformMessage)

        

          /**
 * 
 *
 * @param context         ApplicationContext對象
 * @param inAppMessage    應用內消息
 */
public void onInAppMessageShow(Context context, InAppMessage inAppMessage)

        

          /**
 * 
 *
 * @param context         ApplicationContext對象
 * @param inAppMessage    應用內消息
 */
public void onInAppMessageClick(Context context, InAppMessage inAppMessage)

        

              private void initChannel(){if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {NotificationManager nm = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
            if (nm != null){NotificationChannelGroup notificationChannelGroup = new NotificationChannelGroup("MyGroupId", "自定義通知組");
                nm.createNotificationChannelGroup(notificationChannelGroup);

                NotificationChannel notificationChannel = new NotificationChannel("MyChannelId", "自定義通知", NotificationManager.IMPORTANCE_HIGH);
                notificationChannel.setGroup("MyGroupId");
                notificationChannel.enableLights(true);
                notificationChannel.enableVibration(true);
                notificationChannel.setSound("android.resource:// 包名 /raw/ 鈴聲文件", null);    // 設置自定義鈴聲

                nm.createNotificationChannel(notificationChannel);
            }
        }
    }