MPMssAdapter.framework
中 MPSyncInterface
這個類提供了移動同步服務所有 API 接口, 里面所有的方法都是類方法,可以直接使用類名調用方法。
+(void)initSync;
初始化接口,初始化移動同步服務。如果不調用,將導致當前 App 不能使用本服務。全局僅需調用一次(App 打開到關閉的生命周期內只需要調用一次)。
+(MPSyncNetConnectType)connectStatus;
查看當前移動同步服務連接情況。
返回連接狀態 MPSyncNetConnectType
。
+(BOOL)registerSyncBizWithName:(NSString *)bizName syncObserver:(id)observer selector:(SEL)selector;
注冊對業務名稱為 bizName
的通知監聽,內部調用了 [[NSNotificationCenter defaultCenter] addObserver:observer selector:selector name:bizName object:nil];
進行通知監聽。
bizName
與服務端控制臺配置項對應。如果不調用該接口則不分發該 biz 消息,消息會積壓在客戶端 SDK 的數據庫。如果需要監聽同步服務端消息的同步標識,最好啟動時開始監聽。
返回注冊結果 YES
/NO
。
+(BOOL)unRegisterSyncBizWithName:(NSString *)bizName syncObserver:(id)observer;
通知移動同步服務客戶端 SDK 已經取消某同步配置的消息監聽,不再接收該同步配置的
Sync 消息,內部調用了 [[NSNotificationCenter defaultCenter] removeObserver:observer name:bizName object:nil];
進行監聽移除。
調用該接口后不會再分發該 biz 的消息,消息會積壓在 SyncSDK 的數據庫,與 registerSyncBizWithName
接口對應。
返回結果 YES
/NO
。
+(void)removeSyncNotificationObserver:(id)observer;
取消 Sync 的通知監聽,通常在監聽類的 dealloc
函數中調用,內部調用了[[ NSNotificationCenter defaultCenter] removeObserver:observer];
進行監聽者移除。
無返回值。
+(void)responseMessageNotify:(NSDictionary *)userInfo;
消息處理完成通知回調(callback)
,參數是通知里面的 userInfo(notify.userInfo)
。
回調 SyncSDK
,表示業務數據已經處理在 registerSyncBizWithName
接口注冊的通知處理函數中,數據處理完后調用。
無返回值。
+(void)bindUserWithSessionId:(NSString *)sessionId;
用于登錄信息 userId
或 sessionId
有變化時調用。
登錄時調用,采用的 userId
為 MPaaSInterface
的 -(NSString\*)userId
函數。
如果 sessionId
過期, 或者是客戶端在用戶登錄過一次之后具備了自動免登的功能,那么每次免登成功時也必須要調用本方法。
總體調用原則為:userId
或 sessionId
任意一個發生變化時都必須要調用本方法。
當 userId
發生變化時,先調用 unBindUser
解綁,然后調用bindUserWithSessionId:
重新建連。
sessionId 用于校驗 session 合法性,需要服務端配合。如果設為 nil
,則默認為@”SESSION_DEMO”
。
無返回值。
+(void)unBindUser;
用戶登出時候調用,解綁當前連接用戶。
無返回值。
+(NSString *)getSyncDeviceId;
獲取設備 ID,根據設備維度推 Sync 數據時采用此 ID。
返回設備 ID。
當接口中 SessionId
設置為無效值時,控制臺的用戶一致性選項必須處于關閉狀態,否則校驗不過無法成功推送 Sync。請參考 服務管理 開啟或關閉簽名校驗。