Class DataAttribute.Builder
- All Implemented Interfaces:
DataAttribute._FinalStage,DataAttribute.DataTypeStage,DataAttribute.DescriptionStage,DataAttribute.FullNameStage,DataAttribute.LabelStage,DataAttribute.NameStage
- Enclosing class:
DataAttribute
-
Method Summary
Modifier and TypeMethodDescriptionTeammate who created the attribute.apiWritable(Boolean apiWritable) Can this attribute be updated through APIapiWritable(Optional<Boolean> apiWritable) Is this attribute archived.build()The time the attribute was created as a UTC Unix timestampSet to true if this is a CDAdataType(DataAttribute.DataType dataType) The data type of the attribute.description(String description) Readable description of the attribute.from(DataAttribute other) Full name of the attribute.The unique identifier for the data attribute which is given by Intercom.Readable name of the attribute (i.e.messengerWritable(Boolean messengerWritable) Can this attribute be updated by the MessengermessengerWritable(Optional<Boolean> messengerWritable) model(DataAttribute.Model model) Value iscontactfor user/lead attributes andcompanyfor company attributes.model(Optional<DataAttribute.Model> model) Name of the attribute.List of predefined options for attribute value.uiWritable(Boolean uiWritable) Can this attribute be updated in the UIuiWritable(Optional<Boolean> uiWritable) The time the attribute was last updated as a UTC Unix timestamp
-
Method Details
-
from
- Specified by:
fromin interfaceDataAttribute.NameStage
-
name
Name of the attribute.
- Specified by:
namein interfaceDataAttribute.NameStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
fullName
Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on
.to access nested user object values.- Specified by:
fullNamein interfaceDataAttribute.FullNameStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
label
Readable name of the attribute (i.e. name you see in the UI)
- Specified by:
labelin interfaceDataAttribute.LabelStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
description
Readable description of the attribute.
- Specified by:
descriptionin interfaceDataAttribute.DescriptionStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
dataType
The data type of the attribute.
- Specified by:
dataTypein interfaceDataAttribute.DataTypeStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
adminId
Teammate who created the attribute. Only applicable to CDAs
- Specified by:
adminIdin interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
adminId
- Specified by:
adminIdin interfaceDataAttribute._FinalStage
-
updatedAt
The time the attribute was last updated as a UTC Unix timestamp
- Specified by:
updatedAtin interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
updatedAt
- Specified by:
updatedAtin interfaceDataAttribute._FinalStage
-
createdAt
The time the attribute was created as a UTC Unix timestamp
- Specified by:
createdAtin interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
createdAt
- Specified by:
createdAtin interfaceDataAttribute._FinalStage
-
archived
Is this attribute archived. (Only applicable to CDAs)
- Specified by:
archivedin interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
archived
- Specified by:
archivedin interfaceDataAttribute._FinalStage
-
custom
Set to true if this is a CDA
- Specified by:
customin interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
custom
- Specified by:
customin interfaceDataAttribute._FinalStage
-
uiWritable
Can this attribute be updated in the UI
- Specified by:
uiWritablein interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
uiWritable
- Specified by:
uiWritablein interfaceDataAttribute._FinalStage
-
messengerWritable
Can this attribute be updated by the Messenger
- Specified by:
messengerWritablein interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
messengerWritable
- Specified by:
messengerWritablein interfaceDataAttribute._FinalStage
-
apiWritable
Can this attribute be updated through API
- Specified by:
apiWritablein interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
apiWritable
- Specified by:
apiWritablein interfaceDataAttribute._FinalStage
-
options
List of predefined options for attribute value.
- Specified by:
optionsin interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
options
- Specified by:
optionsin interfaceDataAttribute._FinalStage
-
model
Value is
contactfor user/lead attributes andcompanyfor company attributes.- Specified by:
modelin interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
model
- Specified by:
modelin interfaceDataAttribute._FinalStage
-
id
The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
- Specified by:
idin interfaceDataAttribute._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
id
- Specified by:
idin interfaceDataAttribute._FinalStage
-
build
- Specified by:
buildin interfaceDataAttribute._FinalStage
-