jsforce
Preparing search index...
types/common
Field
Type Alias Field
type
Field
=
{
aggregatable
:
boolean
;
autoNumber
:
boolean
;
byteLength
:
number
;
calculated
:
boolean
;
calculatedFormula
:
Optional
<
string
>
;
cascadeDelete
:
boolean
;
caseSensitive
:
boolean
;
compoundFieldName
:
Optional
<
string
>
;
controllerName
:
Optional
<
string
>
;
createable
:
boolean
;
custom
:
boolean
;
defaultedOnCreate
:
boolean
;
defaultValue
:
Optional
<
string
>
;
defaultValueFormula
:
Optional
<
string
>
;
dependentPicklist
:
boolean
;
deprecatedAndHidden
:
boolean
;
digits
:
number
;
displayLocationInDecimal
:
boolean
;
encrypted
:
boolean
;
externalId
:
boolean
;
extraTypeInfo
:
Optional
<
string
>
;
filterable
:
boolean
;
filteredLookupInfo
:
object
;
groupable
:
boolean
;
highScaleNumber
:
boolean
;
htmlFormatted
:
boolean
;
idLookup
:
boolean
;
inlineHelpText
:
Optional
<
string
>
;
label
:
string
;
length
:
number
;
mask
:
Optional
<
string
>
;
maskType
:
Optional
<
string
>
;
name
:
string
;
nameField
:
boolean
;
namePointing
:
boolean
;
nillable
:
boolean
;
permissionable
:
boolean
;
picklistValues
:
Optional
<
any
[]
>
;
precision
:
number
;
queryByDistance
:
boolean
;
referenceTargetField
:
object
;
referenceTo
:
Optional
<
string
[]
>
;
relationshipName
:
Optional
<
string
>
;
relationshipOrder
:
Optional
<
number
>
;
restrictedDelete
:
boolean
;
restrictedPicklist
:
boolean
;
scale
:
number
;
soapType
:
string
;
sortable
:
boolean
;
type
:
string
;
unique
:
boolean
;
updateable
:
boolean
;
writeRequiresMasterRead
:
boolean
;
}
Index
Properties
aggregatable
auto
Number
byte
Length
calculated
calculated
Formula
cascade
Delete
case
Sensitive
compound
Field
Name
controller
Name
createable
custom
defaulted
On
Create
default
Value
default
Value
Formula
dependent
Picklist
deprecated
And
Hidden
digits
display
Location
In
Decimal
encrypted
external
Id
extra
Type
Info
filterable
filtered
Lookup
Info
groupable
high
Scale
Number
html
Formatted
id
Lookup
inline
Help
Text
label
length
mask
mask
Type
name
name
Field
name
Pointing
nillable
permissionable
picklist
Values
precision
query
By
Distance
reference
Target
Field
reference
To
relationship
Name
relationship
Order
restricted
Delete
restricted
Picklist
scale
soap
Type
sortable
type
unique
updateable
write
Requires
Master
Read
Properties
aggregatable
aggregatable
:
boolean
auto
Number
autoNumber
:
boolean
byte
Length
byteLength
:
number
calculated
calculated
:
boolean
calculated
Formula
calculatedFormula
:
Optional
<
string
>
cascade
Delete
cascadeDelete
:
boolean
case
Sensitive
caseSensitive
:
boolean
compound
Field
Name
compoundFieldName
:
Optional
<
string
>
controller
Name
controllerName
:
Optional
<
string
>
createable
createable
:
boolean
custom
custom
:
boolean
defaulted
On
Create
defaultedOnCreate
:
boolean
default
Value
defaultValue
:
Optional
<
string
>
default
Value
Formula
defaultValueFormula
:
Optional
<
string
>
dependent
Picklist
dependentPicklist
:
boolean
deprecated
And
Hidden
deprecatedAndHidden
:
boolean
digits
digits
:
number
display
Location
In
Decimal
displayLocationInDecimal
:
boolean
encrypted
encrypted
:
boolean
external
Id
externalId
:
boolean
extra
Type
Info
extraTypeInfo
:
Optional
<
string
>
filterable
filterable
:
boolean
filtered
Lookup
Info
filteredLookupInfo
:
object
groupable
groupable
:
boolean
high
Scale
Number
highScaleNumber
:
boolean
html
Formatted
htmlFormatted
:
boolean
id
Lookup
idLookup
:
boolean
inline
Help
Text
inlineHelpText
:
Optional
<
string
>
label
label
:
string
length
length
:
number
mask
mask
:
Optional
<
string
>
mask
Type
maskType
:
Optional
<
string
>
name
name
:
string
name
Field
nameField
:
boolean
name
Pointing
namePointing
:
boolean
nillable
nillable
:
boolean
permissionable
permissionable
:
boolean
picklist
Values
picklistValues
:
Optional
<
any
[]
>
precision
precision
:
number
query
By
Distance
queryByDistance
:
boolean
reference
Target
Field
referenceTargetField
:
object
reference
To
referenceTo
:
Optional
<
string
[]
>
relationship
Name
relationshipName
:
Optional
<
string
>
relationship
Order
relationshipOrder
:
Optional
<
number
>
restricted
Delete
restrictedDelete
:
boolean
restricted
Picklist
restrictedPicklist
:
boolean
scale
scale
:
number
soap
Type
soapType
:
string
sortable
sortable
:
boolean
type
type
:
string
unique
unique
:
boolean
updateable
updateable
:
boolean
write
Requires
Master
Read
writeRequiresMasterRead
:
boolean
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
aggregatable
auto
Number
byte
Length
calculated
calculated
Formula
cascade
Delete
case
Sensitive
compound
Field
Name
controller
Name
createable
custom
defaulted
On
Create
default
Value
default
Value
Formula
dependent
Picklist
deprecated
And
Hidden
digits
display
Location
In
Decimal
encrypted
external
Id
extra
Type
Info
filterable
filtered
Lookup
Info
groupable
high
Scale
Number
html
Formatted
id
Lookup
inline
Help
Text
label
length
mask
mask
Type
name
name
Field
name
Pointing
nillable
permissionable
picklist
Values
precision
query
By
Distance
reference
Target
Field
reference
To
relationship
Name
relationship
Order
restricted
Delete
restricted
Picklist
scale
soap
Type
sortable
type
unique
updateable
write
Requires
Master
Read
jsforce
Loading...