getSingleAttributeByMarkerSet

Mengambil satu atribut dengan data dari set atribut.

Deskripsi

Metode ini mengembalikan satu atribut dengan data dari set atribut. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IAttributesSetsEntity.

AttributesSets.getSingleAttributeByMarkerSet(

setMarker*, attributeMarker*, langCode

);

Skema parameter

Skema

setMarker(diperlukan): string
Identifikasi teks (marker) dari set atribut
contoh: "productAttributes"

attributeMarker(diperlukan): string
Identifikasi teks (marker) dari atribut dalam set
contoh: "color"

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

Contoh

Contoh minimal

const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1');

Contoh dengan atribut langCode

const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1', '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 dari 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 dari 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 dari 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
Sekumpulan validator untuk validasi; objek kosong ketika tidak ada validator yang dikonfigurasi.
contoh:

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

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

{ strict: true }

validators.stringInspectionValidator: object
Batasan panjang untuk field 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>
Atribut sub-nested yang dikunci oleh marker; objek kosong ketika tidak ada.

---