PropertyDefinition interface
Definicja właściwości.
Właściwości
| array |
Separator wartości tablicy dla właściwości z zestawem isArray. |
| data |
Jest to specyficzne dla interakcji modelowanych jako działania. Źródła danych służą do określania, gdzie są przechowywane dane, a także w regułach pierwszeństwa. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer. |
| enum |
Opisuje prawidłowe wartości właściwości wyliczenia. |
| field |
Nazwa właściwości. |
| field |
Typ właściwości. |
| is |
Wskazuje, czy właściwość jest rzeczywiście tablicą fieldType powyżej w interfejsie API danych. |
| is |
Czy właściwość jest dostępna na grafie, czy nie. |
| is |
Wskazuje, czy właściwość jest wyliczeniową. |
| is |
Wskazuje, czy właściwość jest wyliczeniem flagi. |
| is |
Czy właściwość jest obrazem. |
| is |
Czy właściwość jest zlokalizowanym ciągiem. |
| is |
Określa, czy właściwość jest nazwą, czy częścią nazwy. |
| is |
Określa, czy wartość właściwości jest wymagana w wystąpieniach, pole IsRequired tylko dla interakcji. Wystąpienie profilu nie będzie sprawdzane pod kątem wymaganego pola. |
| max |
Maksymalna długość ciągu. Używany tylko wtedy, gdy typ to ciąg. |
| property |
Identyfikator skojarzony z właściwością. |
| schema |
Adres URL zakodowany schema.org link prop elementu dla właściwości. |
Szczegóły właściwości
arrayValueSeparator
Separator wartości tablicy dla właściwości z zestawem isArray.
arrayValueSeparator?: string
Wartość właściwości
string
dataSourcePrecedenceRules
Jest to specyficzne dla interakcji modelowanych jako działania. Źródła danych służą do określania, gdzie są przechowywane dane, a także w regułach pierwszeństwa. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
dataSourcePrecedenceRules?: DataSourcePrecedence[]
Wartość właściwości
enumValidValues
Opisuje prawidłowe wartości właściwości wyliczenia.
enumValidValues?: ProfileEnumValidValuesFormat[]
Wartość właściwości
fieldName
Nazwa właściwości.
fieldName: string
Wartość właściwości
string
fieldType
Typ właściwości.
fieldType: string
Wartość właściwości
string
isArray
Wskazuje, czy właściwość jest rzeczywiście tablicą fieldType powyżej w interfejsie API danych.
isArray?: boolean
Wartość właściwości
boolean
isAvailableInGraph
Czy właściwość jest dostępna na grafie, czy nie.
isAvailableInGraph?: boolean
Wartość właściwości
boolean
isEnum
Wskazuje, czy właściwość jest wyliczeniową.
isEnum?: boolean
Wartość właściwości
boolean
isFlagEnum
Wskazuje, czy właściwość jest wyliczeniem flagi.
isFlagEnum?: boolean
Wartość właściwości
boolean
isImage
Czy właściwość jest obrazem.
isImage?: boolean
Wartość właściwości
boolean
isLocalizedString
Czy właściwość jest zlokalizowanym ciągiem.
isLocalizedString?: boolean
Wartość właściwości
boolean
isName
Określa, czy właściwość jest nazwą, czy częścią nazwy.
isName?: boolean
Wartość właściwości
boolean
isRequired
Określa, czy wartość właściwości jest wymagana w wystąpieniach, pole IsRequired tylko dla interakcji. Wystąpienie profilu nie będzie sprawdzane pod kątem wymaganego pola.
isRequired?: boolean
Wartość właściwości
boolean
maxLength
Maksymalna długość ciągu. Używany tylko wtedy, gdy typ to ciąg.
maxLength?: number
Wartość właściwości
number
propertyId
Identyfikator skojarzony z właściwością.
propertyId?: string
Wartość właściwości
string
schemaItemPropLink
Adres URL zakodowany schema.org link prop elementu dla właściwości.
schemaItemPropLink?: string
Wartość właściwości
string