Class DataAttribute
- java.lang.Object
-
- com.intercom.api.resources.dataattributes.types.DataAttribute
-
public final class DataAttribute extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDataAttribute._FinalStagestatic classDataAttribute.Builderstatic classDataAttribute.DataTypestatic interfaceDataAttribute.DataTypeStagestatic interfaceDataAttribute.FullNameStagestatic interfaceDataAttribute.LabelStagestatic classDataAttribute.Modelstatic interfaceDataAttribute.NameStage
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataAttribute.NameStagebuilder()booleanequals(java.lang.Object other)java.util.Map<java.lang.String,java.lang.Object>getAdditionalProperties()java.util.Optional<java.lang.String>getAdminId()java.util.Optional<java.lang.Boolean>getApiWritable()java.util.Optional<java.lang.Boolean>getArchived()java.util.Optional<java.lang.Integer>getCreatedAt()java.util.Optional<java.lang.Boolean>getCustom()DataAttribute.DataTypegetDataType()java.util.Optional<java.lang.String>getDescription()java.lang.StringgetFullName()java.util.Optional<java.lang.Integer>getId()java.lang.StringgetLabel()java.util.Optional<java.lang.Boolean>getMessengerWritable()java.util.Optional<DataAttribute.Model>getModel()java.lang.StringgetName()java.util.Optional<java.util.List<java.lang.String>>getOptions()java.lang.StringgetType()java.util.Optional<java.lang.Boolean>getUiWritable()java.util.Optional<java.lang.Integer>getUpdatedAt()inthashCode()java.lang.StringtoString()
-
-
-
Method Detail
-
getType
public java.lang.String getType()
- Returns:
- Value is
data_attribute.
-
getId
public java.util.Optional<java.lang.Integer> getId()
- Returns:
- The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
-
getModel
public java.util.Optional<DataAttribute.Model> getModel()
- Returns:
- Value is
contactfor user/lead attributes andcompanyfor company attributes.
-
getName
public java.lang.String getName()
- Returns:
- Name of the attribute.
-
getFullName
public java.lang.String getFullName()
- Returns:
- 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.
-
getLabel
public java.lang.String getLabel()
- Returns:
- Readable name of the attribute (i.e. name you see in the UI)
-
getDescription
public java.util.Optional<java.lang.String> getDescription()
- Returns:
- Readable description of the attribute.
-
getDataType
public DataAttribute.DataType getDataType()
- Returns:
- The data type of the attribute.
-
getOptions
public java.util.Optional<java.util.List<java.lang.String>> getOptions()
- Returns:
- List of predefined options for attribute value.
-
getApiWritable
public java.util.Optional<java.lang.Boolean> getApiWritable()
- Returns:
- Can this attribute be updated through API
-
getMessengerWritable
public java.util.Optional<java.lang.Boolean> getMessengerWritable()
- Returns:
- Can this attribute be updated by the Messenger
-
getUiWritable
public java.util.Optional<java.lang.Boolean> getUiWritable()
- Returns:
- Can this attribute be updated in the UI
-
getCustom
public java.util.Optional<java.lang.Boolean> getCustom()
- Returns:
- Set to true if this is a CDA
-
getArchived
public java.util.Optional<java.lang.Boolean> getArchived()
- Returns:
- Is this attribute archived. (Only applicable to CDAs)
-
getCreatedAt
public java.util.Optional<java.lang.Integer> getCreatedAt()
- Returns:
- The time the attribute was created as a UTC Unix timestamp
-
getUpdatedAt
public java.util.Optional<java.lang.Integer> getUpdatedAt()
- Returns:
- The time the attribute was last updated as a UTC Unix timestamp
-
getAdminId
public java.util.Optional<java.lang.String> getAdminId()
- Returns:
- Teammate who created the attribute. Only applicable to CDAs
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equalsin classjava.lang.Object
-
getAdditionalProperties
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
builder
public static DataAttribute.NameStage builder()
-
-