subscribeToForm
Suscríbete a un evento de formulario por marcador. 🔐 Este método requiere autorización.
Descripción
Este método suscribe al usuario actual a un evento de formulario identificado por su marcador, para un registro de datos de formulario específico. Devuelve una Promesa que se resuelve en true si la suscripción fue exitosa, o un objeto IError si hubo un problema.
Eventos.subscribeToForm(
marker*,
body*,
body.formDataId*,
body.status
);
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.subscribeToForm('form_marker', { formDataId: 123 });
Ejemplo de respuesta
true
Esquema de respuesta
Esquema: boolean
boolean: boolean
Devuelve true si la suscripción fue exitosa.
ejemplo: true