API jembatan JavaScript

Tugas latar belakang

Pekerjaan yang terus berjalan setelah aplikasi ditutup: simpan otomatis yang tahan lama, sinkronisasi berkala.

`workCancel` jembatan#

window.WebToApk.workCancel(id: String)

Tidak perlu izin; hasil dikirim sebagai `appmint:work` / window.onAppMintWork.

Dijelaskan oleh grupnya, Tugas latar belakang (WorkManager): simpan otomatis yang tahan lama + sinkronisasi native berkala, bukan sendiri.

Contoh

Membatalkan tugas latar belakang (sekali jalan atau berulang) berdasarkan id-nya dan menghapus permintaan tersimpannya.

Mengembalikan: tidak ada secara langsung. Event appmint:work (dan window.onAppMintWork) menjawab { id, status: 'cancelled' }. Memerlukan: tidak ada.

function stopSync() {
  if (!(window.WebToApk && window.WebToApk.workCancel)) return;
  WebToApk.workCancel('sync');
}

window.addEventListener('appmint:work', function (e) {
  if (e.detail.id === 'sync' && e.detail.status === 'cancelled') {
    document.getElementById('sync-status').textContent = 'Background sync is off';
  }
});

Buang draf: batalkan simpan otomatisnya yang belum terkirim, lalu kosongkan editor setelah Android mengonfirmasi:

function discardDraft() {
  if (!(window.WebToApk && window.WebToApk.workCancel)) { clearEditor(); return; }
  function onWork(e) {
    if (e.detail.id !== 'autosave' || e.detail.status !== 'cancelled') return;
    window.removeEventListener('appmint:work', onWork);
    clearEditor();
  }
  window.addEventListener('appmint:work', onWork);
  WebToApk.workCancel('autosave');
}

Saat keluar, batalkan setiap tugas aplikasi ini, memakai id yang dilaporkan workList:

function cancelAllJobs() {
  if (!(window.WebToApk && window.WebToApk.workList && window.WebToApk.workCancel)) return;
  const requestId = 'signout-' + Date.now();
  function onWork(e) {
    if (String(e.detail.requestId) !== requestId) return;
    window.removeEventListener('appmint:work', onWork);
    (e.detail.jobs || []).forEach(function (job) {
      WebToApk.workCancel(job.id);                      // each answers { id, status: 'cancelled' }
    });
  }
  window.addEventListener('appmint:work', onWork);
  WebToApk.workList(requestId);
}

Catatan: ia menjawab cancelled bahkan saat tidak ada tugas dengan id itu. Simpan otomatis yang belum terkirim dibuang, jadi batalkan hanya jika Anda memang tidak ingin itu terkirim.

`workEnqueueOnline` jembatan#

window.WebToApk.workEnqueueOnline(id: String, url: String, method: String, headersJson: String, payload: String)

Tidak perlu izin; hasil dikirim sebagai `appmint:work` / window.onAppMintWork.

Dijelaskan oleh grupnya, Tugas latar belakang (WorkManager): simpan otomatis yang tahan lama + sinkronisasi native berkala, bukan sendiri.

Contoh

Menyerahkan satu permintaan HTTP ke Android untuk dikirim saat ponsel online - bahkan jika pengguna menutup aplikasi atau memulai ulang ponsel. Gunakan untuk simpan otomatis yang andal.

Mengembalikan: tidak ada secara langsung. Jawabannya datang sebagai event appmint:work (dan window.onAppMintWork(detail) jika Anda mendefinisikannya): { id, status: 'enqueued' }, atau { id, status: 'failed', reason } dengan alasan invalid_arguments (id kosong atau URL yang tidak diawali http) atau enqueue_failed. Memerlukan: tidak ada.

Simpan otomatis yang tahan lama: id yang sama menggantikan simpanan yang belum terkirim, sehingga status terbaru yang menang.

function autoSave(state, token) {
  if (!(window.WebToApk && window.WebToApk.workEnqueueOnline)) {
    showMessage('Offline auto-save works in the installed app only.');
    return;
  }
  WebToApk.workEnqueueOnline(
    'autosave',                                        // your job id
    'https://api.example.com/save',                    // http(s) URL
    'POST',                                            // POST | PUT | GET ...
    JSON.stringify({ Authorization: 'Bearer ' + token }), // headers as a JSON string
    JSON.stringify(state)                              // body as a string ('' for none)
  );
}

window.addEventListener('appmint:work', function (e) {
  const d = e.detail;
  if (d.id !== 'autosave') return;
  if (d.status === 'enqueued') showSavedBadge('Will sync when online');
  if (d.status === 'failed') showMessage('Could not queue the save: ' + d.reason);
});

Antrekan setiap pengiriman formulir sebagai tugas tersendiri (id unik per pengiriman, sehingga yang kedua tidak menggantikan yang pertama) dan tunggu jawaban Android:

function queueFeedback(form) {
  return new Promise(function (resolve, reject) {
    if (!(window.WebToApk && window.WebToApk.workEnqueueOnline)) {
      reject(new Error('not_in_app'));
      return;
    }
    const id = 'feedback-' + Date.now();
    function onWork(e) {
      if (e.detail.id !== id) return;                  // another job's answer
      window.removeEventListener('appmint:work', onWork);
      if (e.detail.status === 'enqueued') resolve(id);
      else reject(new Error(e.detail.reason));         // invalid_arguments | enqueue_failed
    }
    window.addEventListener('appmint:work', onWork);
    WebToApk.workEnqueueOnline(id, 'https://api.example.com/feedback', 'POST', '{}',
      JSON.stringify({ rating: form.rating.value, text: form.text.value }));
  });
}

Simpan catatan sebagai teks biasa dengan PUT; mengatur Content-Type sendiri mencegah bawaan JSON ditambahkan:

function saveNote(noteId, text) {
  if (!(window.WebToApk && window.WebToApk.workEnqueueOnline)) return;
  WebToApk.workEnqueueOnline(
    'note-' + noteId,                                  // same note, same id: only the newest text is sent
    'https://api.example.com/notes/' + encodeURIComponent(noteId),
    'PUT',
    JSON.stringify({ 'Content-Type': 'text/plain; charset=utf-8' }),
    text
  );
}

document.getElementById('note').addEventListener('change', function (e) {
  saveNote(e.target.dataset.noteId, e.target.value);
});

Catatan: enqueued berarti Android menerima tugas, bukan bahwa server menerimanya; tidak ada event saat terkirim. Aturan pengiriman: balasan 2xx menyelesaikan tugas; balasan 4xx menghentikannya (tanpa coba ulang); kesalahan jaringan atau 5xx mencoba ulang dengan jeda yang bertambah, hingga 8 percobaan. Content-Type: application/json ditambahkan kecuali Anda mengatur sendiri. GET tidak mengirim body. JavaScript halaman tidak berjalan di latar belakang - hanya permintaan native ini yang berjalan.

`workList` jembatan#

window.WebToApk.workList(requestId: String)

Tidak perlu izin; hasil dikirim sebagai `appmint:work` / window.onAppMintWork.

Dijelaskan oleh grupnya, Tugas latar belakang (WorkManager): simpan otomatis yang tahan lama + sinkronisasi native berkala, bukan sendiri.

Contoh

Mencantumkan tugas latar belakang yang telah diantrekan atau dijadwalkan aplikasi ini.

Mengembalikan: tidak ada secara langsung. Event appmint:work (dan window.onAppMintWork) menjawab { requestId, jobs: [{ id, periodic, url, createdAt, pendingDelivery }] }. pendingDelivery bernilai true selama tugas sekali jalan belum terkirim (dan selalu untuk tugas berkala). Memerlukan: tidak ada.

Pembungkus Promise kecil yang mencocokkan jawaban dengan requestId:

function listJobs() {
  return new Promise(function (resolve) {
    if (!(window.WebToApk && window.WebToApk.workList)) { resolve([]); return; }
    const requestId = 'jobs-' + Date.now();
    function onWork(e) {
      if (String(e.detail.requestId) !== requestId) return;   // not our answer
      window.removeEventListener('appmint:work', onWork);
      resolve(e.detail.jobs || []);
    }
    window.addEventListener('appmint:work', onWork);
    WebToApk.workList(requestId);
  });
}

listJobs().then(function (jobs) {
  const unsent = jobs.filter(function (j) { return !j.periodic && j.pendingDelivery; });
  document.getElementById('unsent').textContent =
    unsent.length ? unsent.length + ' change(s) waiting for network' : 'All changes saved';
});

Tampilkan setiap tugas di layar pengaturan, dengan waktu diantrekan:

window.addEventListener('appmint:work', function (e) {
  if (e.detail.requestId !== 'settings-jobs') return;
  const list = document.getElementById('jobs');
  list.innerHTML = '';
  (e.detail.jobs || []).forEach(function (job) {
    const li = document.createElement('li');
    li.textContent = job.id + (job.periodic ? ' (repeats)' : job.pendingDelivery ? ' (waiting)' : '') +
      ' - since ' + new Date(job.createdAt).toLocaleString();
    list.appendChild(li);
  });
});

if (window.WebToApk && window.WebToApk.workList) WebToApk.workList('settings-jobs');

Saat aplikasi dibuka, atur sakelar "Sinkronisasi latar belakang" dari apakah tugas berulang 'sync' masih terdaftar:

window.addEventListener('appmint:work', function (e) {
  if (e.detail.requestId !== 'startup') return;
  const on = (e.detail.jobs || []).some(function (j) { return j.id === 'sync' && j.periodic; });
  document.getElementById('sync-toggle').checked = on;
});

document.addEventListener('DOMContentLoaded', function () {
  if (window.WebToApk && window.WebToApk.workList) WebToApk.workList('startup');
});

Catatan: tugas sekali jalan keluar dari daftar setelah terkirim, ditolak dengan 4xx, atau menyerah setelah 8 percobaan. requestId numerik mungkin dikembalikan sebagai angka, jadi bandingkan dengan String(...).

`workSchedulePeriodic` jembatan#

window.WebToApk.workSchedulePeriodic(id: String, url: String, method: String, headersJson: String, payload: String, intervalMinutes: Int)

Tidak perlu izin; hasil dikirim sebagai `appmint:work` / window.onAppMintWork.

Dijelaskan oleh grupnya, Tugas latar belakang (WorkManager): simpan otomatis yang tahan lama + sinkronisasi native berkala, bukan sendiri.

Contoh

Menjadwalkan permintaan HTTP berulang yang dikirim Android di latar belakang (saat online), bahkan saat aplikasi ditutup. Cocok untuk pemicu sinkronisasi atau heartbeat.

Mengembalikan: tidak ada secara langsung. Jawabannya datang sebagai event appmint:work (dan window.onAppMintWork(detail)): { id, status: 'scheduled', intervalMinutes }, atau { id, status: 'failed', reason } dengan alasan invalid_arguments atau schedule_failed. Memerlukan: tidak ada.

function startBackgroundSync(userId) {
  if (!(window.WebToApk && window.WebToApk.workSchedulePeriodic)) {
    showMessage('Background sync works in the installed app only.');
    return;
  }
  WebToApk.workSchedulePeriodic(
    'sync',                                   // job id (scheduling again updates it)
    'https://api.example.com/sync',
    'POST',
    JSON.stringify({ 'X-User': userId }),     // headers as a JSON string
    JSON.stringify({ userId: userId }),       // the same body is sent every time
    30                                        // minutes; values under 15 become 15
  );
}

// Optional page hook instead of addEventListener:
window.onAppMintWork = function (d) {
  if (d.id === 'sync' && d.status === 'scheduled') {
    console.log('sync every', d.intervalMinutes, 'minutes');
  }
  if (d.status === 'failed') console.warn('job', d.id, 'failed:', d.reason);
};

Detak sekali per jam: GET tidak mengirim body, jadi berikan string kosong, dan '{}' saat Anda tidak butuh header:

function startHeartbeat(deviceId) {
  if (!(window.WebToApk && window.WebToApk.workSchedulePeriodic)) return;
  WebToApk.workSchedulePeriodic(
    'heartbeat',
    'https://api.example.com/ping?device=' + encodeURIComponent(deviceId),
    'GET',
    '{}',
    '',
    60
  );
}

Biarkan pengguna memilih seberapa sering menyinkronkan, dan tampilkan interval yang sebenarnya dipakai Android (apa pun di bawah 15 dikembalikan sebagai 15):

document.getElementById('sync-every').addEventListener('change', function (e) {
  if (!(window.WebToApk && window.WebToApk.workSchedulePeriodic)) return;
  const minutes = parseInt(e.target.value, 10);        // e.g. 5, 30, 120
  WebToApk.workSchedulePeriodic('sync', 'https://api.example.com/sync', 'POST', '{}',
    JSON.stringify({ reason: 'periodic' }), minutes);  // same id: updates the existing job
});

window.addEventListener('appmint:work', function (e) {
  const d = e.detail;
  if (d.id !== 'sync') return;
  if (d.status === 'scheduled') {
    document.getElementById('sync-note').textContent = 'Syncing about every ' + d.intervalMinutes + ' minutes';
  } else if (d.status === 'failed') {
    document.getElementById('sync-note').textContent = 'Could not schedule sync (' + d.reason + ')';
  }
});

Catatan: Android menentukan saat tepatnya; 15 menit adalah interval terpendek, dan penghematan baterai dapat menunda eksekusi. Body ditetapkan saat Anda menjadwalkan; untuk mengubahnya, jadwalkan lagi dengan id yang sama. Balasan 4xx tidak membatalkan tugas berkala; eksekusi berikutnya mencoba lagi. Hentikan dengan workCancel('sync').

workCancel jembatan#

workEnqueueOnline jembatan#

workList jembatan#

workSchedulePeriodic jembatan#

`workCancel` jembatan#

`workEnqueueOnline` jembatan#

`workList` jembatan#

`workSchedulePeriodic` jembatan#