getFormByMarker

Получение одного объекта формы по маркеру.

Описание

Этот метод извлекает один объект формы на основе его текстового идентификатора (маркер) из API. Он возвращает Promise, который разрешается в объект FormEntity.

Forms.getFormByMarker(

marker, langCode

);

Схема параметров

Схема

marker(обязательный): string
Маркер формы
пример: "contact_form"

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

Примеры

Минимальный пример

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

Пример с атрибутами

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

Пример ответа

{
  "id": 6,
  "attributeSetId": 15,
  "type": "data",
  "localizeInfos": {
    "title": "Тестовая форма",
    "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": "Имя"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "file",
      "marker": "file",
      "isLogin": null,
      "isSignUp": null,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Файл"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

Схема ответа

Схема: IFormsEntity

id: number
Идентификатор объекта.
пример: 12345

attributeSetId: number | null
Идентификатор используемого набора атрибутов, или null, если не применимо.
пример: 1234

type: string | null
Тип формы.
пример: "contact"

localizeInfos: ILocalizeInfo
Название формы с учетом локализации.
пример:

{
  "key": "value"
}

version: number
Номер версии объекта.
пример: 1

position: number
Позиция объекта.
пример: 1

identifier: string
Текстовый идентификатор для поля записи.
пример: "form_contact_us"

processingType: string
Тип обработки формы.
пример: "async"

templateId: number | null
Идентификатор шаблона, используемого формой, или null, если шаблон не используется.
пример: 6789

attributes: IAttributes[] | Record<string, any>
Атрибуты формы, которые могут быть массивом объектов атрибутов или записью пар ключ-значение.
пример:

{
  "key": "value"
}

---