Ana içeriğe geç

getAllForms

Tüm form nesnelerini al.

Açıklama​

Bu yöntem, API'den tüm form nesnelerini alır. Bir Promise döner ve bu Promise, FormEntity nesnelerinin bir dizisine çözülür. Bir Promise döner ve bu Promise, bir IFormsEntity[] nesnesine çözülür.

Forms.getAllForms(

langCode, offset, limit

);

Parametreler şeması​

Şema

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Sayfalandırma için parametre. Varsayılan: 0
örnek: 0

limit: number
Sayfalandırma için parametre. Varsayılan: 30
örnek: 30

Örnekler​

Minimal örnek​

const response = await Forms.getAllForms();

Özelliklerle örnek​

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

Örnek yanıt​

[
  {
    "id": 9,
    "attributeSetId": 20,
    "type": "sing_in_up",
    "localizeInfos": {
      "title": "Kayıt",
      "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": "email"
        },
        "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": "şifre"
        },
        "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": "isim"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      "..."
    ]
  },
  {
    "id": 8,
    "attributeSetId": 14,
    "type": "order",
    "localizeInfos": {
      "title": "Sipariş",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 1,
    "position": 2,
    "identifier": "orderForm",
    "processingType": "script",
    "templateId": null,
    "attributes": [
      {
        "type": "string",
        "marker": "order_name",
        "isLogin": null,
        "isSignUp": null,
        "position": 1,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {},
        "localizeInfos": {
          "title": "isim"
        },
        "additionalFields": [],
        "isNotificationEmail": null,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      }
    ]
  },
  {
    "id": 10,
    "attributeSetId": 16,
    "type": "data",
    "localizeInfos": {
      "title": "Koleksiyon formu ru_RU",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 3,
    "identifier": "collection_form",
    "processingType": "script",
    "templateId": null,
    "attributes": {}
  },
  "..."
]

Yanıt şeması​

Şema: IFormsEntity[]

id: number
Nesnenin tanımlayıcısı.
örnek: 12345

attributeSetId: number | null
Kullanılan özellik setinin tanımlayıcısı veya geçerli değilse null.
örnek: 1234

type: string | null
Form türü.
örnek: "contact"

localizeInfos: ILocalizeInfo
Formun adı, yerelleştirmeyi dikkate alarak.
örnek:

{
  "key": "value"
}

version: number
Nesnenin sürüm numarası.
örnek: 1

position: number
Nesnenin konumu.
örnek: 1

identifier: string
Kayıt alanı için metinsel tanımlayıcı.
örnek: "form_contact_us"

processingType: string
Form işleme türü.
örnek: "async"

templateId: number | null
Form tarafından kullanılan şablonun tanımlayıcısı veya hiç şablon kullanılmıyorsa null.
örnek: 6789

attributes: IAttributes[] | Record<string, any>
Formun özellikleri, bir dizi özellik nesnesi veya anahtar-değer çiftleri kaydı olabilir.
örnek:

{
  "key": "value"
}