unsubscribeFromForm

Cancele a inscrição nas notificações do formulário pelo marcador. 🔐 Este método requer autorização.

Descrição

Este método cancela a inscrição do usuário atual em um evento de formulário identificado pelo seu marcador, para um registro específico de dados do formulário. Ele retorna uma Promise que resolve para true se a desinscrição foi bem-sucedida, ou um objeto IError se houve um problema.

⚠️ Com a configuração padrão errors.isShell: true, uma solicitação rejeitada é retornada em vez de lançada: este método resolve para um objeto IError, nunca para false. Verifique result === true - um objeto de erro é verdadeiro, então if (result) trataria uma falha como sucesso.

Eventos.unsubscribeFromForm(

marker*, body*

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Marcador do evento
exemplo: "form_marker"

body(obrigatório): ISubscribeFormEvent
Corpo da inscrição. Exemplo: { formDataId: 123 }

body.formDataId(obrigatório): number
Identificador dos dados do formulário.
exemplo: 123

body.status: string
Status da inscrição opcional.

Exemplos

Exemplo mínimo

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

Exemplo de resposta

true

Esquema de resposta

Esquema: boolean

boolean: boolean
Retorna true se a desinscrição foi bem-sucedida.
exemplo: true

---