説明 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 オブジェクトは、モバイル同期サービス (MSS) のすべての機能を提供します。
java.lang.Object
- com.mpaas.mss.adapter.api.MPSync以下は public 関数です：
戻り値 | 説明 |
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 | Application インスタンス。 |
戻り値
なし。
appToBackground()
宣言
public static void appToBackground()
説明
アプリがバックグラウンドに入るたびにこのメソッドを呼び出してください。これにより、クライアント SDK に通知され、アプリがサーバーから切断されます。
アプリがバックグラウンドに移行するときにこの API 操作を呼び出さないと、ネットワーク接続が長時間アクティブなままになり、消費電力とデータトラフィックが増加します。ホームページの onStop() メソッドでこのメソッドを呼び出してください。
パラメーター
なし。
戻り値
なし。
appToForeground()
宣言
public static void appToForeground()
説明
このメソッドは、アプリが起動したことをクライアント SDK に通知し、サーバーとのネットワーク接続を確立します。アプリがフォアグラウンドに移行するたびに、このメソッドを呼び出してください。
このメソッドは、ホームページの onResume() メソッドで呼び出すことができます。
パラメーター
なし。
戻り値
なし。
clearUserInfo()
宣言
public static void clearUserInfo()
説明
ユーザーをログアウトさせます。
パラメーター
なし。
戻り値
なし。
initialize(Context context)
宣言
public static void initialize(Context ctx)
説明
モバイル同期サービスを初期化します。アプリがこのサービスを使用する前に、このメソッドを呼び出す必要があります。
このメソッドは、アプリのライフサイクルごとに 1 回だけ呼び出してください。
パラメーター
パラメーター | タイプ | 説明 |
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 | 同期 ID。 |
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 | 同期 ID。 |
戻り値
なし。
updateUserInfo(String sessionId)
宣言
public static boolean updateUserInfo(String sessionId)
説明
このメソッドは、内部で LongLinkSyncService.getInstance().updateUserInfo(String userId, String sessionId) メソッドを呼び出します。userId は MPLogger で設定されたユーザー ID です。userId または sessionId が変更されたとき、セッションの有効期限が切れたとき、または自動ログインが成功したときは、このメソッドを呼び出してユーザーのログイン情報を更新する必要があります。このメソッドを呼び出すとき、どちらのパラメーターも空にすることはできません。userId が設定されていない場合、メソッドは false を返し、呼び出しは失敗します。
パラメーター
パラメーター | タイプ | 説明 |
sessionId | String | セッション ID。 |
戻り値
ユーザー情報が正常に更新された場合は true を返し、ログイン時に userId が設定されていない場合は false を返します。