說明 自 2020 年 6 月 28 日起，mPaaS 停止維護 10.1.32 基準。請使用 10.1.68 或 10.1.60 系列基準。可以參考 mPaaS 10.1.68 升級指南 或 mPaaS 10.1.60 升級指南 進行基準版本升級。 |
在 10.1.32 及以後的基準版本中，mPaaS 中介層的 MPSync 類封裝了移動同步群組件所有 API。通過 MPSync 對象即可實現移動同步的所有功能。
java.lang.Object
- com.mpaas.mss.adapter.api.MPSync涉及的公用函數列表如下：
傳回值 | 說明 |
void |
|
void |
|
void |
|
void |
|
void |
|
boolean |
|
void |
|
void |
|
void |
|
boolean |
|
setup(Application application)
聲明
public static void setup(Application application)
說明
用於初始化移動同步服務依賴的基礎服務，在 initialize 方法調用前調用。僅限 10.1.60 及以上版本基準。
參數
參數 | 類型 | 說明 |
application | Application | Applicaiton 執行個體。 |
傳回值
無。
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 開啟到關閉的生命週期內只需要調用一次）。
參數
參數 | 類型 | 說明 |
ctx | Context | 一個不為空白的 |
傳回值
無。
isConnected()
聲明
public static boolean isConnected()
說明
檢查當前移動同步服務是否正常。
參數
無。
傳回值
正常返回 true；不正常返回 false。
registerBiz(String bizType, ISyncCallback syncCallback)
聲明
public static void registerBiz(String biz, ISyncCallback callback)
說明
用於註冊一個接收業務資料的 callback。在擷取到同步推送的資料後，用戶端 SDK 會回調 syncCallback 實作類別。
每個同步配置都需調用一次該 API。
參數
參數 | 類型 | 說明 |
bizType | String | 同步標識 |
syncCallback | ISyncCallback | 回調實作類別 |
傳回值
無。
reportMsgReceived(SyncMessage syncMessag)
聲明
public static void reportMsgReceived(SyncMessage msg)
說明
用於在 syncCallback 中收到同步推送的資料後，調用該介面通知移動同步服務端接收同步資料成功。在沒有收到 reportMsgReceived 前，移動同步服務端會重試投遞，重試 6 次之後資料就被永久刪除。
參數
參數 | 類型 | 說明 |
syncMessag | SyncMessage | 同步訊息 |
傳回值
無。
unregisterBiz(String bizType)
聲明
public static void unregisterBiz(String biz)
說明
反註冊指定同步配置。移動同步服務在收到該同步配置的資料後，不會調用 syncCallback。
參數
參數 | 類型 | 說明 |
biz | String | 同步標識 |
傳回值
無。
updateUserInfo(String sessionId)
聲明
public static boolean updateUserInfo(String sessionId)
說明
方法內部的調用基於 LongLinkSyncService.getInstance().updateUserInfo(String userId, String sessionId)介面，其中 userId 使用的是在 MPLogger 中設定的使用者識別碼。該介面用於在登入資訊 userId/sessionId 有變化時調用，以更新使用者登入資訊。登入時，兩個參數都不可為空，如果 userId 未設定，該方法會返回 false，調用失敗。如果 session 到期，或者是用戶端在使用者登入過一次之後具備了自動免登的功能，那麼每次免登成功時也必須要調用本方法。總體調用原則是： userId 與 sessionId 兩個參數任意一個發生變化時都必須要調用本方法。
參數
參數 | 類型 | 說明 |
sessionId | String | 會話 ID。 |
傳回值
更新使用者資訊成功則返回 true；如果登入時 userId 未設定返回 false。