getFormByMarker

Lấy một đối tượng biểu mẫu theo marker.

Phương thức này truy xuất một đối tượng biểu mẫu duy nhất dựa trên định danh văn bản (marker) của nó từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng FormEntity.

Forms.getFormByMarker( marker, langCode );

Ví dụ tối thiểu

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

Ví dụ với các thuộc tính

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

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Marker của biểu mẫu
ví dụ: "contact_form"

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

Ví dụ phản hồi

{
  "id": 6,
  "attributeSetId": 15,
  "type": "data",
  "localizeInfos": {
    "title": "Biểu mẫu kiểm tra",
    "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": "Tên"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "file",
      "marker": "file",
      "isLogin": null,
      "isSignUp": null,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Tập tin"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

Sơ đồ phản hồi

Sơ đồ: IFormsEntity

id: number
Định danh của đối tượng.
ví dụ: 12345

attributeSetId: number | null
Định danh của bộ thuộc tính đang được sử dụng, hoặc null nếu không áp dụng.
ví dụ: 1234

type: string | null
Loại biểu mẫu.
ví dụ: "contact"

localizeInfos: ILocalizeInfo
Tên của biểu mẫu, tính đến việc địa phương hóa.
ví dụ:

{
  "key": "value"
}

version: number
Số phiên bản của đối tượng.
ví dụ: 1

position: number
Vị trí của đối tượng.
ví dụ: 1

identifier: string
Định danh văn bản cho trường bản ghi.
ví dụ: "form_contact_us"

processingType: string
Loại xử lý biểu mẫu.
ví dụ: "async"

templateId: number | null
Định danh của mẫu được sử dụng bởi biểu mẫu, hoặc null nếu không sử dụng mẫu nào.
ví dụ: 6789

attributes: IAttributes[] | Record<string, any>
Các thuộc tính của biểu mẫu, có thể là một mảng các đối tượng thuộc tính hoặc một bản ghi các cặp khóa-giá trị.
ví dụ:

{
  "key": "value"
}

---