Pular para o conteúdo principal

getAllForms

Obtenha todos os objetos de formulário.

Descrição​

Este método recupera todos os objetos de formulário com paginação. Ele retorna uma Promise que resolve para um objeto IFormsResponse contendo itens e contagem total.

Forms.getAllForms(

langCode, offset, limit

);

Esquema de parâmetros​

Esquema

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro 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 as Permissões do módulo de acordo com suas necessidades na seção correspondente.

Exemplos​

Exemplo mínimo​

const response = await Forms.getAllForms();

Exemplo com atributos​

const response = await Forms.getAllForms('en_US', 0, 30);

Exemplo de resposta​

{
  "items": [
    {
      "id": 4,
      "attributeSetId": 11,
      "type": "data",
      "localizeInfos": {
        "title": "user_form",
        "titleForSite": "",
        "successMessage": "",
        "unsuccessMessage": "",
        "urlAddress": "",
        "database": "0",
        "script": "0"
      },
      "version": 9,
      "position": 1,
      "identifier": "user_form",
      "processingType": "script",
      "templateId": null,
      "attributes": [
        {
          "type": "string",
          "marker": "name_attr",
          "position": 1,
          "settings": {},
          "isVisible": true,
          "listTitles": [],
          "validators": {},
          "initialValue": null,
          "localizeInfos": {
            "title": "name"
          },
          "additionalFields": {}
        },
        {
          "type": "string",
          "marker": "username",
          "position": 2,
          "settings": {},
          "isVisible": true,
          "listTitles": [],
          "validators": {},
          "initialValue": null,
          "localizeInfos": {
            "title": "username"
          },
          "additionalFields": {}
        },
        {
          "type": "string",
          "marker": "password",
          "position": 3,
          "settings": {},
          "isVisible": true,
          "listTitles": [],
          "validators": {},
          "initialValue": null,
          "localizeInfos": {
            "title": "password"
          },
          "additionalFields": {}
        },
        "..."
      ]
    },
    {
      "id": 6,
      "attributeSetId": 15,
      "type": "data",
      "localizeInfos": {
        "title": "Test form",
        "titleForSite": "",
        "successMessage": "",
        "unsuccessMessage": "",
        "urlAddress": "",
        "database": "0",
        "script": "0"
      },
      "version": 14,
      "position": 2,
      "identifier": "test-form",
      "processingType": "script",
      "templateId": null,
      "attributes": [
        {
          "type": "string",
          "marker": "name",
          "position": 1,
          "settings": {},
          "isVisible": true,
          "listTitles": [],
          "validators": {
            "requiredValidator": {
              "strict": true
            },
            "stringInspectionValidator": {
              "stringMax": 0,
              "stringMin": 0,
              "stringLength": 0
            }
          },
          "initialValue": null,
          "localizeInfos": {
            "title": "Name"
          },
          "additionalFields": {
            "additional_field": {
              "type": "string",
              "value": "Additional field data"
            }
          }
        },
        {
          "type": "file",
          "marker": "file",
          "position": 2,
          "settings": {},
          "isVisible": true,
          "listTitles": [],
          "validators": {},
          "initialValue": null,
          "localizeInfos": {
            "title": "File"
          },
          "additionalFields": {}
        }
      ]
    },
    {
      "id": 7,
      "attributeSetId": 15,
      "type": "data",
      "localizeInfos": {
        "title": "File form",
        "titleForSite": "Form title (for application)",
        "successMessage": "Message about successful data processing",
        "unsuccessMessage": "Message about unsuccessful data processing",
        "urlAddress": "",
        "database": "0",
        "script": "0"
      },
      "version": 15,
      "position": 3,
      "identifier": "file_form",
      "processingType": "script",
      "templateId": null,
      "attributes": [
        {
          "type": "string",
          "marker": "name",
          "position": 1,
          "settings": {},
          "isVisible": true,
          "listTitles": [],
          "validators": {
            "requiredValidator": {
              "strict": true
            },
            "stringInspectionValidator": {
              "stringMax": 0,
              "stringMin": 0,
              "stringLength": 0
            }
          },
          "initialValue": null,
          "localizeInfos": {
            "title": "Name"
          },
          "additionalFields": {
            "additional_field": {
              "type": "string",
              "value": "Additional field data"
            }
          }
        },
        {
          "type": "file",
          "marker": "file",
          "position": 2,
          "settings": {},
          "isVisible": true,
          "listTitles": [],
          "validators": {},
          "initialValue": null,
          "localizeInfos": {
            "title": "File"
          },
          "additionalFields": {}
        }
      ]
    },
    "..."
  ],
  "total": 9
}

Esquema de resposta​

Esquema: IFormsEntity[]

total: number
Contagem total de itens.

items: IFormsEntity[]
Array de entidades de formulário.

items.id: number
O identificador do objeto.
exemplo: 12345

items.attributeSetId: number | null
O identificador do conjunto de atributos sendo usado, ou null se não aplicável.
exemplo: 1234

items.type: string | null
Tipo de formulário.
exemplo: "contato"

items.localizeInfos: IFormLocalizeInfo
O nome do formulário e campos de localização do lado do formulário (mensagens de sucesso/erro, configuração de processamento, etc.).
exemplo:

{
  "key": "value"
}

items.version: number
O número da versão do objeto.
exemplo: 1

items.position: number
A posição do objeto.
exemplo: 1

items.identifier: string
O identificador textual para o campo do registro.
exemplo: "form_contact_us"

items.processingType: string
Tipo de processamento do formulário.
exemplo: "assíncrono"

items.templateId: number | null
O identificador do template usado pelo formulário, ou null se nenhum template for usado.
exemplo: 6789

items.attributes: IFormAttribute[]
Campos do formulário com sua localização, validadores e flags específicas do formulário.

items.total: number | string
Contagem total de entradas relacionadas.
exemplo: "1"

items.moduleFormConfigs: IFormConfig[]
Array de configurações de formulário do módulo associadas ao formulário.

Exemplos de uso​

Passo a passo na documentação:

Experimente ao vivo​

Execute este método interativamente no sandbox do JS SDK — conecte sua URL do Projeto e Token do App na primeira visita, depois abra: