Lewati ke konten utama

getAttributesByMarker

Mengambil semua atribut dengan data dari set atribut.

Deskripsi​

Metode ini mengembalikan semua atribut dengan data dari set atribut. Ini mengembalikan Promise yang menyelesaikan menjadi array objek IAttributesSetsEntity - entitas atribut itu sendiri (marker, type, value, listTitles, validators, localizeInfos, additionalFields, …), bukan entitas set atribut.

AttributesSets.getAttributesByMarker(

marker*, langCode

);

Skema parameter​

Skema

marker(diperlukan): string
Marker atribut
contoh: "productAttributes"

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

Contoh​

Contoh minimal​

const response = await AttributesSets.getAttributesByMarker('my-marker');

Contoh dengan atribut​

const response = await AttributesSets.getAttributesByMarker('my-marker', 'en_US');

Contoh respons​

[
  {
    "type": "string",
    "value": null,
    "marker": "admin-text",
    "position": 1,
    "listTitles": [],
    "validators": {},
    "multiselect": false,
    "initialValue": null,
    "localizeInfos": {
      "title": "Admins text"
    },
    "additionalFields": {}
  }
]

Skema respons​

Skema: IAttributesSetsEntity[]

type: AttributeType
Jenis atribut.
contoh: "string", "text", "integer", "dll"

value: unknown
Nilai atribut, dinormalisasi dengan cara yang sama seperti nilai atribut entitas: number | null untuk tipe numerik, objek file itu sendiri untuk image/file satu file, null ketika atribut tidak memiliki nilai.

initialValue: unknown
Nilai awal atribut.

marker: string
Identifikasi tekstual dari atribut (marker).
contoh: "color", "size", "dll"

position: number
Nomor posisi untuk pengurutan.
contoh: 1

listTitles: IListTitle[]
Array nilai (dengan data tambahan) untuk atribut list dan radioButton; array kosong untuk tipe non-list.
contoh:

[
  {
    "title": "red",
    "value": 1,
    "position": 1,
    "extendedValue": null,
    "extendedValueType": null
  },
  {
    "title": "yellow",
    "value": 2,
    "position": 2,
    "extendedValue": null,
    "extendedValueType": null
  }
]

listTitles.title: string
Judul atau nama yang terkait dengan item daftar.
contoh: "Nama Item"

listTitles.value: number | string
Nilai item daftar, yang bisa berupa angka atau string tergantung pada konteks.
contoh: 42

listTitles.position: string | number | null
Posisi item daftar, yang dapat direpresentasikan sebagai string, angka, atau null jika tidak berlaku.
contoh: 1

listTitles.extended: object
Objek yang berisi properti tambahan atau metadata terkait dengan item daftar. Ini bisa mencakup detail tambahan yang memperluas informasi dasar.

listTitles.extended.value: string | null
Nilai tambahan, yang bisa berupa string atau null.
contoh: "extra_value"

listTitles.extended.type: string | null
Jenis nilai tambahan, yang bisa berupa string atau null.
contoh: "color"

validators: IAttributeValidators
Set validator untuk validasi; objek kosong ketika tidak ada validator yang dikonfigurasi.
contoh:

{
  "requiredValidator": {
    "strict": true
  },
  "defaultValueValidator": {
    "fieldDefaultValue": 11
  }
}

validators.requiredValidator: object
Menandai bidang sebagai wajib. Bentuk: { strict: boolean }.
contoh:

{ strict: true }

validators.stringInspectionValidator: object
Batasan panjang untuk bidang string. Bentuk: { stringMin: number; stringMax: number; stringLength: number }.

validators.emailInspectionValidator: boolean
Toggle untuk validasi format email.

validators.defaultValueValidator: object
Konfigurasi nilai default dengan teks kesalahan kustom opsional. Bentuk: { customErrorText?: string; fieldDefaultValue?: unknown; fieldDefaultValue2?: unknown }.

localizeInfos: IAttributeLocalizeInfo
Nama template, dengan mempertimbangkan lokalisasi.
contoh:

{
  "title": "My attribute"
}

additionalFields: Record<string, IAttributesSetsEntity>
Sub-atribut bersarang yang dikunci oleh marker; objek kosong ketika tidak ada.

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: