getAllForms

Obtiene todos los objetos de formulario.

Forms?.getAllForms( langCode?, offset?, limit? );

Ejemplo mínimo

const value = await Forms.getAllForms()

Esquema

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

offset: number
Parámetro para la paginación. Predeterminado: 0
ejemplo: 0

limit: number
Parámetro para la paginación. Predeterminado: 30
ejemplo: 30

Este método recupera todos los objetos de formulario de la API. Devuelve una Promesa que se resuelve en un array de objetos FormEntity.

Ejemplo de respuesta

[
  {
    "id": 9,
    "attributeSetId": 20,
    "type": "sing_in_up",
    "localizeInfos": {
      "title": "Registro",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 1,
    "identifier": "reg",
    "processingType": "script",
    "templateId": null,
    "attributes": [
      {
        "type": "string",
        "marker": "email_reg",
        "isLogin": true,
        "isSignUp": false,
        "position": 1,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {
          "emailInspectionValidator": true
        },
        "localizeInfos": {
          "title": "correo electrónico"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      {
        "type": "string",
        "marker": "password_reg",
        "isLogin": null,
        "isSignUp": false,
        "position": 2,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {
          "requiredValidator": {
            "strict": true
          },
          "stringInspectionValidator": {
            "stringMax": 0,
            "stringMin": 0,
            "stringLength": 0
          }
        },
        "localizeInfos": {
          "title": "contraseña"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      {
        "type": "string",
        "marker": "name_reg",
        "isLogin": null,
        "isSignUp": true,
        "position": 3,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {},
        "localizeInfos": {
          "title": "nombre"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      "..."
    ]
  },
  {
    "id": 11,
    "attributeSetId": 28,
    "type": "data",
    "localizeInfos": {
      "title": "Horario",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 2,
    "identifier": "schedule_form",
    "processingType": "script",
    "templateId": null,
    "attributes": [
      {
        "type": "timeInterval",
        "marker": "schedule",
        "isLogin": null,
        "isSignUp": null,
        "position": 1,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {},
        "localizeInfos": {
          "title": "Horario",
          "intervals": [
            {
              "id": "f88c8793-798d-4fb1-9f8f-7b2013bcf04f",
              "range": [
                "2025-05-07T21:00:00.000Z",
                "2025-05-07T21:00:00.000Z"
              ],
              "external": [],
              "intervals": [
                {
                  "id": "47851bf0-1d39-422f-a155-3a6ba1d00a13",
                  "end": {
                    "hours": 12,
                    "minutes": 0
                  },
                  "start": {
                    "hours": 9,
                    "minutes": 0
                  },
                  "period": 60
                }
              ],
              "inEveryWeek": true,
              "inEveryMonth": true
            }
          ]
        },
        "additionalFields": [],
        "isNotificationEmail": null,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      }
    ]
  },
  {
    "id": 10,
    "attributeSetId": 16,
    "type": null,
    "localizeInfos": {
      "title": "Formulario de colección ru_RU",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 3,
    "identifier": "collection_form",
    "processingType": "script",
    "templateId": null,
    "attributes": {}
  },
  "..."
]

Esquema

id: number
El identificador del objeto.
ejemplo: 12345

attributeSetId: number | null
El identificador del conjunto de atributos que se está utilizando, o null si no es aplicable.
ejemplo: 1234

type: string | null
Tipo de formulario.
ejemplo: "contact"

localizeInfos: ILocalizeInfo
El nombre del formulario, teniendo en cuenta la localización.
ejemplo:

{
  "key": "value"
}

version: number
El número de versión del objeto.
ejemplo: 1

position: number
La posición del objeto.
ejemplo: 1

identifier: string
El identificador textual para el campo del registro.
ejemplo: "form_contact_us"

processingType: string
Tipo de procesamiento del formulario.
ejemplo: "async"

templateId: number | null
El identificador de la plantilla utilizada por el formulario, o null si no se utiliza ninguna plantilla.
ejemplo: 6789

attributes: IAttributes[] | Record<string, any>
Los atributos del formulario, que pueden ser un array de objetos de atributo o un registro de pares clave-valor.
ejemplo:

{
  "key": "value"
}

---