在 10.1.32 及以后的基線版本中，mPaaS 中間層的 MPSync 類封裝了移動同步組件所有 API。通過 MPSync 對象即可實現移動同步的所有功能。

java.lang.Object
  - com.mpaas.mss.adapter.api.MPSync

涉及的公共函數列表如下：

setup(Application application)

聲明

public static void setup(Application application)

說明

用于初始化移動同步服務依賴的基礎服務，在 initialize 方法調用前調用。僅限 10.1.60 及以上版本基線。

參數

返回值

無。

appToBackground()

聲明

public static void appToBackground()

說明

用于讓客戶端 SDK 感知到當前 App 已經回到后臺，使其斷開與服務器的網絡連接。每次 App 壓后臺時調用。

建議在首頁的 onStop() 方法內調用。如果壓后臺不調用此 API， 將會導致長時間網絡連接，帶來耗電量、流量增加的問題。

參數

無。

返回值

無。

appToForeground()

聲明

public static void appToForeground()

說明

用于讓客戶端 SDK 感知到當前 App 已經啟動，使其建立與服務器的網絡連接。每次 App 回到前臺時調用。

建議在首頁的 onResume() 方法內調用。

參數

無。

返回值

無。

clearUserInfo()

聲明

public static void clearUserInfo()

說明

用于用戶登出。

參數

無。

返回值

無。

initialize(Context context)

聲明

public static void initialize(Context ctx)

說明

初始化接口，初始化移動同步服務。如果不調用，將導致當前 App 不能使用本服務。

全局僅需調用一次（App 打開到關閉的生命周期內只需要調用一次）。

參數

返回值

無。

isConnected()

聲明

public static boolean isConnected()

說明

檢查當前移動同步服務是否正常。

參數

無。

返回值

正常返回 true；不正常返回 false。

registerBiz(String bizType, ISyncCallback syncCallback)

聲明

public static void registerBiz(String biz, ISyncCallback callback)

說明

用于注冊一個接收業務數據的 callback。在獲取到同步推送的數據后，客戶端 SDK 會回調 syncCallback 實現類。

每個同步配置都需調用一次該 API。

參數

返回值

無。

reportMsgReceived(SyncMessage syncMessag)

聲明

public static void reportMsgReceived(SyncMessage msg)

說明

用于在 syncCallback 中收到同步推送的數據后，調用該接口通知移動同步服務端接收同步數據成功。在沒有收到 reportMsgReceived 前，移動同步服務端會重試投遞，重試 6 次之后數據就被永久刪除。

參數

返回值

無。

unregisterBiz(String bizType)

聲明

public static void unregisterBiz(String biz)

說明

反注冊指定同步配置。移動同步服務在收到該同步配置的數據后，不會調用 syncCallback。

參數

返回值

無。

updateUserInfo(String sessionId)

聲明

public static boolean updateUserInfo(String sessionId)

說明

方法內部的調用基于 LongLinkSyncService.getInstance().updateUserInfo(String userId, String sessionId)接口，其中 userId 使用的是在 MPLogger 中設置的用戶 ID。該接口用于在登錄信息 userId/sessionId 有變化時調用，以更新用戶登錄信息。登錄時，兩個參數都不能為空，如果 userId 未設置，該方法會返回 false，調用失敗。如果 session 過期，或者是客戶端在用戶登錄過一次之后具備了自動免登的功能，那么每次免登成功時也必須要調用本方法。總體調用原則是： userId 與 sessionId 兩個參數任意一個發生變化時都必須要調用本方法。

參數

返回值

更新用戶信息成功則返回 true；如果登錄時 userId 未設置返回 false。