All Products
Search
Document Center

Mobile Platform as a Service:Android API

Last Updated:Jan 21, 2026

Catatan

Sejak 28 Juni 2020, mPaaS tidak lagi menyediakan pemeliharaan untuk baseline 10.1.32. Gunakan baseline seri 10.1.68 atau 10.1.60. Untuk melakukan upgrade versi baseline Anda, lihat mPaaS 10.1.68 Upgrade Guide atau mPaaS 10.1.60 Upgrade Guide.

Pada baseline 10.1.32 dan versi selanjutnya, kelas MPSync di lapisan tengah mPaaS mengenkapsulasi semua operasi API untuk komponen sinkronisasi mobile. Objek MPSync menyediakan semua fitur MSS.

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

Berikut adalah fungsi publiknya:

Nilai kembalian

Deskripsi

void

setup(Application application): Menginisialisasi layanan dasar yang diperlukan oleh layanan sinkronisasi mobile. Panggil metode ini sebelum memanggil metode initialize. Metode ini hanya tersedia untuk versi baseline 10.1.60 dan yang lebih baru.

void

appToBackground(): Memberi tahu client SDK bahwa aplikasi telah berpindah ke background. Hal ini memutus koneksi aplikasi dari server. Panggil metode ini setiap kali aplikasi berpindah ke background.

void

appToForeground(): Memberi tahu client SDK bahwa aplikasi telah dimulai. Hal ini membangun koneksi jaringan dengan server. Panggil metode ini setiap kali aplikasi berpindah ke foreground.

void

clearUserInfo(): Melakukan logout pengguna.

void

initialize(Context context): Menginisialisasi layanan sinkronisasi mobile.

boolean

isConnected(): Memeriksa apakah layanan sinkronisasi mobile terhubung.

void

registerBiz(String bizType, ISyncCallback syncCallback): Mendaftarkan callback untuk menerima data bisnis. Setelah data yang disinkronkan didorong dan diterima, client SDK memanggil kelas implementasi syncCallback.

void

reportMsgReceived(SyncMessage syncMessag): Setelah menerima data dalam kelas implementasi syncCallback, panggil metode ini untuk memberi tahu server sinkronisasi mobile bahwa data telah berhasil diterima. Jika server tidak menerima notifikasi reportMsgReceived, server akan mencoba mengirimkan ulang data tersebut. Setelah enam kali percobaan, data tersebut akan dihapus secara permanen.

void

unregisterBiz(String bizType): Membatalkan pendaftaran konfigurasi sinkronisasi tertentu. Setelah pembatalan pendaftaran, client SDK tidak akan memanggil kelas implementasi syncCallback ketika menerima data yang didorong untuk konfigurasi tersebut.

boolean

updateUserInfo(String sessionId): Panggil metode ini ketika informasi login, seperti userId atau sessionId, berubah. Metode ini harus dipanggil setidaknya satu kali.

setup(Application application)

Deklarasi

public static void setup(Application application)

Deskripsi

Menginisialisasi layanan dasar yang dibutuhkan oleh layanan sinkronisasi mobile. Panggil metode ini sebelum memanggil metode initialize. Metode ini hanya tersedia pada baseline 10.1.60 dan versi yang lebih baru.

Parameter

Parameter

Tipe

Deskripsi

application

Application

Instans Aplikasi.

Nilai kembalian

Tidak ada.

appToBackground()

Deklarasi

public static void appToBackground()

Deskripsi

Panggil metode ini setiap kali aplikasi masuk ke background. Hal ini memberi tahu client SDK dan memutus koneksi aplikasi dari server.

Panggil metode ini di dalam metode onStop() halaman utama. Jika Anda tidak memanggil operasi API ini saat aplikasi berpindah ke background, koneksi jaringan akan tetap aktif dalam waktu lama, sehingga meningkatkan konsumsi daya dan penggunaan data.

Parameter

Tidak ada.

Nilai kembalian

Tidak ada.

appToForeground()

Deklarasi

public static void appToForeground()

Deskripsi

Metode ini memberi tahu client SDK bahwa aplikasi telah dimulai, yang kemudian membangun koneksi jaringan dengan server. Panggil metode ini setiap kali aplikasi berpindah ke foreground.

Anda dapat memanggil metode ini di dalam metode onResume() halaman utama.

Parameter

Tidak ada.

Nilai kembalian

Tidak ada.

clearUserInfo()

Deklarasi

public static void clearUserInfo()

Deskripsi

Logout pengguna.

Parameter

Tidak ada.

Nilai kembalian

Tidak ada.

initialize(Context context)

Deklarasi

public static void initialize(Context ctx)

Deskripsi

Menginisialisasi layanan sinkronisasi mobile. Metode ini harus dipanggil sebelum aplikasi dapat menggunakan layanan tersebut.

Panggil metode ini hanya sekali per siklus hidup aplikasi.

Parameter

Parameter

Tipe

Deskripsi

ctx

Context

Context yang tidak kosong.

Nilai kembalian

Tidak ada.

isConnected()

Deklarasi

public static boolean isConnected()

Deskripsi

Memverifikasi apakah layanan sinkronisasi mobile terhubung.

Parameter

Tidak ada.

Nilai kembalian

Mengembalikan true jika berhasil atau false jika gagal.

registerBiz(String bizType, ISyncCallback syncCallback)

Deklarasi

public static void registerBiz(String biz, ISyncCallback callback)

Deskripsi

Mendaftarkan callback untuk menerima data bisnis. Client SDK memanggil kelas implementasi syncCallback setelah menerima data yang disinkronkan.

Anda dapat memanggil operasi API ini untuk setiap konfigurasi sinkronisasi.

Parameter

Parameter

Tipe

Deskripsi

bizType

String

Identitas sinkronisasi.

syncCallback

ISyncCallback

Kelas implementasi callback.

Nilai kembalian

Tidak ada.

reportMsgReceived(SyncMessage syncMessag)

Deklarasi

public static void reportMsgReceived(SyncMessage msg)

Deskripsi

Setelah Anda menerima data yang didorong di dalam metode syncCallback, panggil metode ini untuk memberi tahu server sinkronisasi mobile bahwa data telah berhasil diterima. Jika server tidak menerima notifikasi reportMsgReceived, server akan mencoba mengirimkan ulang data tersebut. Setelah enam kali percobaan, data tersebut akan dihapus secara permanen.

Parameter

Parameter

Jenis

Deskripsi

syncMessag

SyncMessage

Pesan sinkronisasi.

Nilai kembalian

Tidak ada.

unregisterBiz(String bizType)

Deklarasi

public static void unregisterBiz(String biz)

Deskripsi

Membatalkan pendaftaran konfigurasi sinkronisasi tertentu. Setelah konfigurasi dibatalkan pendaftarannya, layanan sinkronisasi mobile tidak lagi memanggil syncCallback ketika menerima data untuk konfigurasi tersebut.

Parameter

Parameter

Tipe

Deskripsi

biz

String

Identitas sinkronisasi.

Nilai kembalian

Tidak ada.

updateUserInfo(String sessionId)

Deklarasi

public static boolean updateUserInfo(String sessionId)

Deskripsi

Metode ini secara internal memanggil metode LongLinkSyncService.getInstance().updateUserInfo(String userId, String sessionId). userId adalah ID pengguna yang ditetapkan di MPLogger. Anda harus memanggil metode ini untuk memperbarui informasi login pengguna setiap kali userId atau sessionId berubah, sesi berakhir, atau login otomatis berhasil. Saat memanggil metode ini, kedua parameter tidak boleh kosong. Jika userId tidak ditetapkan, metode ini mengembalikan false dan pemanggilan gagal.

Parameter

Parameter

Tipe

Deskripsi

sessionId

String

ID sesi.

Nilai kembalian

Mengembalikan true jika informasi pengguna berhasil diperbarui, atau false jika userId tidak ditetapkan saat login.