unsubscribeFromForm

Hủy đăng ký nhận thông báo từ biểu mẫu theo marker. 🔐 Phương thức này yêu cầu ủy quyền.

Mô tả

Phương thức này hủy đăng ký người dùng hiện tại khỏi một sự kiện biểu mẫu được xác định bởi marker của nó, cho một bản ghi dữ liệu biểu mẫu cụ thể. Nó trả về một Promise mà sẽ giải quyết thành true nếu việc hủy đăng ký thành công, hoặc một đối tượng IError nếu có vấn đề xảy ra.

⚠️ Với cài đặt mặc định errors.isShell: true, một yêu cầu bị từ chối sẽ được trả về thay vì bị ném ra: phương thức này sẽ giải quyết thành một đối tượng IError, không bao giờ thành false. Kiểm tra result === true - một đối tượng lỗi là đúng, vì vậy if (result) sẽ coi một thất bại là thành công.

Events.unsubscribeFromForm(

marker*, body*

);

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Marker sự kiện
ví dụ: "form_marker"

body(bắt buộc): ISubscribeFormEvent
Nội dung đăng ký. Ví dụ: { formDataId: 123 }

body.formDataId(bắt buộc): number
Định danh dữ liệu biểu mẫu.
ví dụ: 123

body.status: string
Trạng thái đăng ký tùy chọn.

Ví dụ

Ví dụ tối thiểu

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

Phản hồi ví dụ

true

Sơ đồ phản hồi

Sơ đồ: boolean

boolean: boolean
Trả về true nếu việc hủy đăng ký thành công.
ví dụ: true

---