unsubscribeFromForm

Batalkan langganan dari notifikasi formulir berdasarkan penanda. 🔐 Metode ini memerlukan otorisasi.

Deskripsi

Metode ini membatalkan langganan pengguna saat ini dari acara formulir yang diidentifikasi oleh penandanya, untuk catatan data formulir tertentu. Ini mengembalikan Promise yang menyelesaikan menjadi true jika pembatalan langganan berhasil, atau objek IError jika ada masalah.

⚠️ Dengan pengaturan default errors.isShell: true, permintaan yang ditolak dikembalikan daripada dilempar: metode ini menyelesaikan menjadi objek IError, tidak pernah menjadi false. Periksa result === true - objek kesalahan adalah truthy, jadi if (result) akan memperlakukan kegagalan sebagai keberhasilan.

Events.unsubscribeFromForm(

marker*, body*

);

Skema parameter

Skema

marker(diperlukan): string
Penanda acara
contoh: "form_marker"

body(diperlukan): ISubscribeFormEvent
Isi langganan. Contoh: { formDataId: 123 }

body.formDataId(diperlukan): number
Identifikasi data formulir.
contoh: 123

body.status: string
Status langganan opsional.

Contoh

Contoh minimal

const response = await Events.unsubscribeFromForm('form_marker', { formDataId: 123 });

Contoh respons

true

Skema respons

Skema: boolean

boolean: boolean
Mengembalikan true jika pembatalan langganan berhasil.
contoh: true

---