Share via

PropertyDefinition interface

  • Reference
Package:
@azure/arm-customerinsights

Property definition.

Properties

arrayValueSeparator

Array value separator for properties with isArray set.
dataSourcePrecedenceRules

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. NOTE: This property will not be serialized. It can only be populated by the server.
enumValidValues

Describes valid values for an enum property.
fieldName

Name of the property.
fieldType

Type of the property.
isArray

Indicates if the property is actually an array of the fieldType above on the data api.
isAvailableInGraph

Whether property is available in graph or not.
isEnum

Indicates if the property is an enum.
isFlagEnum

Indicates if the property is an flag enum.
isImage

Whether the property is an Image.
isLocalizedString

Whether the property is a localized string.
isName

Whether the property is a name or a part of name.
isRequired

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
maxLength

Max length of string. Used only if type is string.
propertyId

The ID associated with the property.
schemaItemPropLink

URL encoded schema.org item prop link for the property.

Property Details

arrayValueSeparator

Array value separator for properties with isArray set.

arrayValueSeparator?: string

Property Value

string

dataSourcePrecedenceRules

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. NOTE: This property will not be serialized. It can only be populated by the server.

dataSourcePrecedenceRules?: DataSourcePrecedence[]

Property Value

DataSourcePrecedence[]

enumValidValues

Describes valid values for an enum property.

enumValidValues?: ProfileEnumValidValuesFormat[]

Property Value

ProfileEnumValidValuesFormat[]

fieldName

Name of the property.

fieldName: string

Property Value

string

fieldType

Type of the property.

fieldType: string

Property Value

string

isArray

Indicates if the property is actually an array of the fieldType above on the data api.

isArray?: boolean

Property Value

boolean

isAvailableInGraph

Whether property is available in graph or not.

isAvailableInGraph?: boolean

Property Value

boolean

isEnum

Indicates if the property is an enum.

isEnum?: boolean

Property Value

boolean

isFlagEnum

Indicates if the property is an flag enum.

isFlagEnum?: boolean

Property Value

boolean

isImage

Whether the property is an Image.

isImage?: boolean

Property Value

boolean

isLocalizedString

Whether the property is a localized string.

isLocalizedString?: boolean

Property Value

boolean

isName

Whether the property is a name or a part of name.

isName?: boolean

Property Value

boolean

isRequired

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

isRequired?: boolean

Property Value

boolean

maxLength

Max length of string. Used only if type is string.

maxLength?: number

Property Value

number

propertyId

The ID associated with the property.

propertyId?: string

Property Value

string

URL encoded schema.org item prop link for the property.

schemaItemPropLink?: string

Property Value

string