unsubscribeFromForm

Darse de baja de las notificaciones del formulario por marcador. 🔐 Este método requiere autorización.

Descripción

Este método da de baja al usuario actual de un evento de formulario identificado por su marcador, para un registro específico de datos del formulario. Devuelve una Promesa que se resuelve en true si la baja fue exitosa, o un objeto IError si hubo un problema.

⚠️ Con la configuración predeterminada errors.isShell: true, una solicitud rechazada es devuelta en lugar de lanzada: este método se resuelve en un objeto IError, nunca en false. Verifica result === true - un objeto de error es verdadero, por lo que if (result) trataría un fallo como éxito.

Eventos.unsubscribeFromForm(

marker*, body*

);

Esquema de parámetros

Esquema

marker(requerido): string
Marcador del evento
ejemplo: "form_marker"

body(requerido): ISubscribeFormEvent
Cuerpo de la suscripción. Ejemplo: { formDataId: 123 }

body.formDataId(requerido): number
Identificador de datos del formulario.
ejemplo: 123

body.status: string
Estado de suscripción opcional.

Ejemplos

Ejemplo mínimo

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

Ejemplo de respuesta

true

Esquema de respuesta

Esquema: boolean

boolean: boolean
Devuelve true si la baja fue exitosa.
ejemplo: true

---