- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Contact.Builder,Contact>
A contact is the end-user who is receiving the email.
- See Also:
Method Details
emailAddress
public final String emailAddress()The contact's email address.
- Returns:
- The contact's email address.
hasTopicPreferences
public final boolean hasTopicPreferences()
For responses, this returns true if the service returned a value for the TopicPreferences property. This DOES NOT check that the value is non-empty (for which, you should check the
isEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.topicPreferences
The contact's preference for being opted-in to or opted-out of a topic.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTopicPreferences()method.- Returns:
- The contact's preference for being opted-in to or opted-out of a topic.
hasTopicDefaultPreferences
public final boolean hasTopicDefaultPreferences()
For responses, this returns true if the service returned a value for the TopicDefaultPreferences property. This DOES NOT check that the value is non-empty (for which, you should check the
isEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.topicDefaultPreferences
The default topic preferences applied to the contact.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTopicDefaultPreferences()method.- Returns:
- The default topic preferences applied to the contact.
unsubscribeAll
public final Boolean unsubscribeAll()A boolean value status noting if the contact is unsubscribed from all contact list topics.
- Returns:
- A boolean value status noting if the contact is unsubscribed from all contact list topics.
lastUpdatedTimestamp
public final Instant lastUpdatedTimestamp()A timestamp noting the last time the contact's information was updated.
- Returns:
- A timestamp noting the last time the contact's information was updated.
toBuilder
Take this object and create a builder that contains all of the current property values of this object.
- Specified by:
toBuilderin interfaceToCopyableBuilder<Contact.Builder,Contact> - Returns:
- a builder for type T
builder
serializableBuilderClass
hashCode
public final int hashCode()
equals
public final boolean equals(Object obj) equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)Description copied from interface: SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
toString
public final String toString()Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
getValueForField
sdkFields