全部产品
云市场

Android 接口说明

更新时间:2020-04-10 15:51:58

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

概览

在 10.1.32 及以后的基线版本中,mPaaS 中间层的 MPSync 类封装了移动同步组件所有 API。通过 MPSync 对象即可实现移动同步的所有功能。

公共函数

公共函数
void setup(Application application)
用于初始化移动同步服务依赖的基础服务,在 initialize 方法调用前调用。仅限 10.1.60 及以上版本基线。
void appToBackground()
用于让客户端 SDK 感知到当前 App 已经回到后台,使其断开与服务器的网络连接。每次 App 压后台时调用。
void appToForeground()
用于让客户端 SDK 感知到当前 App 已经启动,使其建立与服务器的网络连接。每次 App 回前台时调用。
void clearUserInfo()
用于用户登出。
void initialize(Context context)
初始化接口,初始化移动同步服务。
boolean isConnected()
用于检查当前移动同步服务是否正常。
void registerBiz(String
bizType, ISyncCallback syncCallback)
用于注册一个接收业务数据的 callback。在获取到同步推送的数据后,客户端 SDK 会回调 syncCallback实现类。
void reportMsgReceived(SyncMessage syncMessag)
用于在 syncCallback 实现类中收到数据后,调用该接口通知移动同步服务端接收同步数据成功。在没有收到 reportMsgReceived 前,移动同步服务会重试投递,重试 6 次之后数据会被永久删除。
void unregisterBiz(String bizType)
用于反注册指定同步配置。在获取到同步推送的数据后,客户端 SDK 则不会回调 syncCallback 实现类。
boolean updateUserInfo(String sessionId)
用于登录信息 userId/sessionId 有变化时调用,需至少调用一次。

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:一个不为空的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 中设置的用户 ID。
用于在登录信息 userId/sessionId 有变化时调用,以更新用户登录信息。
登录时,两个参数都不能为空,如果 userId 未设置,该方法会返回 false,调用失败。
如果 session 过期,或者是客户端在用户登录过一次之后具备了自动免登的功能,那么每次免登成功时也必须要调用本方法。总体调用原则是: userIdsessionId 两个参数任意一个发生变化时都必须要调用本方法。
参数

sessionId String:会话 ID。
返回值
更新用户信息成功则返回 true。
如果登录时 userId 未设置返回 false。