Pular para o conteúdo principal

getFormSubscriptions

Obtenha todas as assinaturas de formulário. 🔐 Este método requer autorização.

Descrição​

Este método retorna todas as assinaturas de formulário do usuário atual. Ele retorna uma Promise que resolve para um objeto IFormSubscriptionsResponse - um contêiner com items (as entradas IListFormSubscription) e total - não um array simples.

Events.getFormSubscriptions(

offset, limit

);

Esquema de parâmetros​

Esquema

offset: number
Deslocamento opcional para paginação. Padrão: 0
exemplo: 0

limit: number
Limite opcional para paginação. Padrão: 30
exemplo: 30

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar Permissões do módulo de acordo com suas necessidades na seção correspondente.*

Exemplos​

Exemplo mínimo​

const response = await Events.getFormSubscriptions();

Exemplo com atributos​

const response = await Events.getFormSubscriptions(0, 30);

Exemplo de resposta​

{
  "total": 0,
  "items": []
}

Esquema de resposta​

Esquema: IFormSubscriptionsResponse

items: IListFormSubscription[]
Array de assinaturas de formulário.

items.eventMarker: string
Marcador de evento.
exemplo: "form_marker"

items.formDataId: number
Identificador de dados do formulário.
exemplo: 123

total: number
Número total de assinaturas.
exemplo: 0