Pular para o conteúdo principal

getFormByMarker

Obtendo um objeto de formulário por marcador.

Este método recupera um único objeto de formulário com base em seu identificador textual (marcador) da API. Ele retorna uma Promise que resolve para um objeto FormEntity.

Forms.getFormByMarker( marker, langCode );

Exemplo mínimo​

const value = await Forms.getFormByMarker('my-form');

Exemplo com atributos​

const value = await Forms.getFormByMarker('my-form', 'en_US');

Esquema de parâmetros​

Esquema

marker(required): string
Marcador do formulário
exemplo: "contact_form"

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

Exemplo de resposta​

{
  "id": 6,
  "attributeSetId": 15,
  "type": "data",
  "localizeInfos": {
    "title": "Formulário de teste",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 4,
  "position": 1,
  "identifier": "test-form",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "string",
      "marker": "name",
      "isLogin": null,
      "isSignUp": null,
      "position": 1,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Nome"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "file",
      "marker": "file",
      "isLogin": null,
      "isSignUp": null,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Arquivo"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

Esquema de resposta​

Esquema: IFormsEntity

id: number
O identificador do objeto.
exemplo: 12345

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

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

localizeInfos: ILocalizeInfo
O nome do formulário, levando em consideração a localização.
exemplo:

{
  "key": "value"
}

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

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

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

processingType: string
Tipo de processamento do formulário.
exemplo: "async"

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

attributes: IAttributes[] | Record<string, any>
Os atributos do formulário, que podem ser um array de objetos de atributo ou um registro de pares chave-valor.
exemplo:

{
  "key": "value"
}