getSingleAttributeByMarkerSet
الحصول على سمة واحدة مع بيانات من مجموعة السمات.
الوصف
ترجع هذه الطريقة سمة واحدة مع بيانات من مجموعات السمات. ترجع وعدًا (Promise) يتم حله إلى كائن IAttributesSetsEntity.
AttributesSets.getSingleAttributeByMarkerSet(
setMarker*,
attributeMarker*,
langCode
);
مخطط المعلمات
المخطط
setMarker(مطلوب): string
معرف نصي (علامة) لمجموعة السمات
مثال: "productAttributes"
attributeMarker(مطلوب): string
معرف نصي (علامة) للسمة في المجموعة
مثال: "color"
langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"
أمثلة
مثال بسيط
const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1');
مثال مع خاصية langCode
const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1', 'en_US');
مثال على الاستجابة
{
"type": "string",
"value": {},
"marker": "admin-text",
"position": 1,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "Admins text"
},
"additionalFields": {}
}
مخطط الاستجابة
المخطط: IAttributesSetsEntity
type: AttributeType
نوع السمة.
مثال: "string"، "text"، "integer"، "إلخ"
value: unknown
قيمة السمة، التي يمكن أن تكون من أي نوع.
initialValue: unknown
القيمة الأولية للسمة.
marker: string
معرف نصي للسمة (علامة).
مثال: "color"، "size"، "إلخ"
position: number
رقم الموضع للفرز.
مثال: 1
listTitles: IListTitle[]
مصفوفة من القيم (مع بيانات موسعة) لسمات القائمة و radioButton؛ مصفوفة فارغة للأنواع غير القائمة.
مثال:
[
{
"title": "red",
"value": 1,
"position": 1,
"extendedValue": null,
"extendedValueType": null
},
{
"title": "yellow",
"value": 2,
"position": 2,
"extendedValue": null,
"extendedValueType": null
}
]
listTitles.title: string
العنوان أو الاسم المرتبط بعنصر القائمة.
مثال: "اسم العنصر"
listTitles.value: number | string
قيمة عنصر القائمة، التي يمكن أن تكون إما رقمًا أو سلسلة نصية حسب السياق.
مثال: 42
listTitles.position: string | number | null
موضع عنصر القائمة، الذي يمكن تمثيله كسلسلة نصية أو رقم أو null إذا لم يكن ذلك مناسبًا.
مثال: 1
listTitles.extended: object
كائن يحتوي على خصائص إضافية أو بيانات وصفية تتعلق بعنصر القائمة. قد يتضمن ذلك أي تفاصيل إضافية توسع المعلومات الأساسية.
listTitles.extended.value: string | null
القيمة الموسعة، التي يمكن أن تكون سلسلة نصية أو null.
مثال: "extra_value"
listTitles.extended.type: string | null
نوع القيمة الموسعة، التي يمكن أن تكون سلسلة نصية أو null.
مثال: "color"
validators: IAttributeValidators
مجموعة من المدققين للتحقق؛ كائن فارغ عند عدم تكوين أي مدققين.
مثال:
{
"requiredValidator": {
"strict": true
},
"defaultValueValidator": {
"fieldDefaultValue": 11
}
}
validators.requiredValidator: object
يحدد الحقل كمطلوب. الشكل: { strict: boolean }.
مثال: { strict: true }
validators.stringInspectionValidator: object
قيود الطول لحقول السلسلة. الشكل: { stringMin: number; stringMax: number; stringLength: number }.
validators.emailInspectionValidator: boolean
تبديل للتحقق من تنسيق البريد الإلكتروني.
validators.defaultValueValidator: object
تكوين القيمة الافتراضية مع نص خطأ مخصص اختياري. الشكل: { customErrorText?: string; fieldDefaultValue?: unknown; fieldDefaultValue2?: unknown }.
localizeInfos: IAttributeLocalizeInfo
اسم القالب، مع الأخذ في الاعتبار التوطين.
مثال:
{
"title": "My attribute"
}
additionalFields: Record<string, IAttributesSetsEntity>
سمات فرعية متداخلة مفاتيحها بواسطة العلامة؛ كائن فارغ عند عدم وجود أي منها.