Lewati ke konten utama

getAllForms

Ambil semua objek formulir.

Deskripsi​

Metode ini mengambil semua objek formulir dengan paginasi. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IFormsResponse yang berisi item dan total jumlah.

Forms.getAllForms(

langCode, offset, limit

);

Skema parameter​

Skema

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

offset: number
Parameter untuk paginasi. Default: 0
contoh: 0

limit: number
Parameter untuk paginasi. Default: 30
contoh: 30

Secara default, Anda dapat mengambil 10 objek. Ini disebabkan oleh batasan jumlah rekaman dalam pengaturan izin modul.
Agar paginasi berfungsi dengan benar, Anda perlu mengonfigurasi Izin modul sesuai kebutuhan Anda di bagian yang sesuai.

Contoh​

Contoh minimal​

const response = await Forms.getAllForms();

Contoh dengan atribut​

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

Contoh respons​

{
  "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
}

Skema respons​

Skema: IFormsEntity[]

total: number
Total jumlah item.

items: IFormsEntity[]
Array dari entitas formulir.

items.id: number
Pengidentifikasi objek.
contoh: 12345

items.attributeSetId: number | null
Pengidentifikasi set atribut yang digunakan, atau null jika tidak berlaku.
contoh: 1234

items.type: string | null
Tipe formulir.
contoh: "contact"

items.localizeInfos: IFormLocalizeInfo
Nama formulir dan bidang lokalisasi sisi formulir (pesan sukses/gagal, konfigurasi pemrosesan, dll.).
contoh:

{
  "key": "value"
}

items.version: number
Nomor versi objek.
contoh: 1

items.position: number
Posisi objek.
contoh: 1

items.identifier: string
Pengidentifikasi tekstual untuk bidang rekaman.
contoh: "form_contact_us"

items.processingType: string
Tipe pemrosesan formulir.
contoh: "async"

items.templateId: number | null
Pengidentifikasi template yang digunakan oleh formulir, atau null jika tidak ada template yang digunakan.
contoh: 6789

items.attributes: IFormAttribute[]
Bidang formulir dengan lokalisasi, validator, dan bendera spesifik formulir.

items.total: number | string
Total jumlah entri terkait.
contoh: "1"

items.moduleFormConfigs: IFormConfig[]
Array konfigurasi formulir modul yang terkait dengan formulir.

Contoh penggunaan​

Panduan langkah demi langkah dalam dokumentasi:

Coba secara langsung​

Jalankan metode ini secara interaktif di JS SDK sandbox — sambungkan URL Proyek dan Token Aplikasi Anda pada kunjungan pertama, lalu buka: