Mobile Platform as a Service:Android API

ベースライン 10.1.32 以降のバージョンでは、mPaaS 中間層の MPSync クラスがモバイル同期サービス (MSS) のすべての API をカプセル化しています。MPSync オブジェクトを使用して、MSS のすべての機能を実装できます。

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

関連するパブリック関数は次のとおりです。

• setup(Application application)

• appToBackground()

• appToForeground()

• clearUserInfo()

• initialize(Context context)

• isConnected()

• registerBiz(String bizType, ISyncCallback syncCallback)

• reportMsgReceived(SyncMessage syncMessag)

• unregisterBiz(String bizType)

• updateUserInfo(String sessionId)

setup(Application application)

宣言

public static void setup(Application application)

説明

MSS が依存する基本サービスを初期化するために使用されます。この関数は、initialize メソッドが呼び出される前に呼び出す必要があります。この関数は、ベースライン 10.1.60 以降のバージョンでのみ使用できます。

パラメーター

戻り値

なし。

appToBackground()

宣言

public static void appToBackground()

説明

アプリがバックグラウンドに切り替えられ、サーバーから切断する必要があることをクライアント SDK に通知します。アプリがバックグラウンドに切り替えられるたびに、この関数を呼び出します。

この API は、ホームページの onStop() メソッド内で呼び出すことをお勧めします。アプリがバックグラウンドに切り替わったときにこの API が呼び出されない場合、アプリとサーバー間のネットワーク接続がタイムリーに解放されず、電力消費とトラフィック使用量が増加します。

パラメーター

なし。

戻り値

なし。

appToForeground()

宣言

public static void appToForeground()

説明

アプリがフォアグラウンドに切り替えられ、サーバーに接続する必要があることをクライアント SDK に通知します。アプリがフォアグラウンドに切り替えられるたびに、この関数を呼び出します。

ホームページの onResume() メソッド内でこの API を呼び出すことをお勧めします。

パラメーター

なし。

戻り値

なし。

clearUserInfo()

宣言

public static void clearUserInfo()

説明

ユーザーがログオフしたときにユーザー情報をクリアします。

パラメーター

なし。

戻り値

なし。

initialize(Context context)

宣言

public static void initialize(Context ctx)

説明

この API を呼び出して、MSS を初期化できます。アプリは、この API を呼び出した後にのみ MSS を使用できます。

アプリのライフサイクル中 (アプリが起動されてから停止されるまで)、この API は一度だけ呼び出す必要があります。

パラメーター

戻り値

なし。

isConnected()

宣言

public static boolean isConnected()

説明

MSS が正しく実行されているかどうかを確認します。

パラメーター

なし。

戻り値

サービスが正常な場合は true を返し、サービスが異常な場合は false を返します。

registerBiz(String bizType, ISyncCallback syncCallback)

宣言

public static void registerBiz(String biz, ISyncCallback callback)

説明

サービスデータを受信するためのコールバックを登録するために使用されます。この API が呼び出されると、クライアント SDK は同期データを受信した後に syncCallback クラスを呼び出します。

この API は、同期構成ごとに 1 回呼び出す必要があります。

パラメーター

戻り値

なし。

reportMsgReceived(SyncMessage syncMessag)

宣言

public static void reportMsgReceived(SyncMessage msg)

説明

同期的にプッシュされたデータが syncCallback で受信された後、この API を呼び出して、同期データが正常に受信されたことを MSS に通知します。reportMsgReceived を受信する前は、MSS は最大 6 回データの再送信を試みます。すべての再送信試行が失敗した場合、データは完全に削除されます。

パラメーター

戻り値

なし。

unregisterBiz(String bizType)

宣言

public static void unregisterBiz(String biz)

説明

指定された同期構成の登録を解除します。MSS が同期構成データを受信した後、MSS は syncCallback を呼び出しません。

パラメーター

戻り値

なし。

updateUserInfo(String sessionId)

宣言

public static boolean updateUserInfo(String sessionId)

説明

メソッド内での呼び出しは、LongLinkSyncService.getInstance().updateUserInfo(String userId, String sessionId) API に基づいており、userId は MPLogger で指定されたユーザー ID を示します。この API は、userId または sessionId が変更されたときに呼び出され、ユーザーログイン情報を更新します。

ログインするには両方のパラメーターが必要です。userId が指定されていない場合、このメソッドは false を返し、呼び出しの失敗を示します。

パラメーター

戻り値

ユーザー情報が正常に更新された場合は true を返し、ログイン時に userId が設定されていない場合は false を返します。