Class CampaignInAppMessage
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CampaignInAppMessage.Builder,
CampaignInAppMessage>
In-app message configuration.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
body()
The message body of the notification, the email body or the text message.static CampaignInAppMessage.Builder
builder()
final List
<InAppMessageContent> content()
In-app message content.Custom config to be sent to client.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Content property.final boolean
For responses, this returns true if the service returned a value for the CustomConfig property.final int
hashCode()
final Layout
layout()
In-app message layout.final String
In-app message layout.static Class
<? extends CampaignInAppMessage.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
body
The message body of the notification, the email body or the text message.
- Returns:
- The message body of the notification, the email body or the text message.
-
hasContent
public final boolean hasContent()For responses, this returns true if the service returned a value for the Content property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
content
In-app message content.
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
hasContent()
method.- Returns:
- In-app message content.
-
hasCustomConfig
public final boolean hasCustomConfig()For responses, this returns true if the service returned a value for the CustomConfig property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
customConfig
Custom config to be sent to client.
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
hasCustomConfig()
method.- Returns:
- Custom config to be sent to client.
-
layout
In-app message layout.
If the service returns an enum value that is not available in the current SDK version,
layout
will returnLayout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlayoutAsString()
.- Returns:
- In-app message layout.
- See Also:
-
layoutAsString
In-app message layout.
If the service returns an enum value that is not available in the current SDK version,
layout
will returnLayout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlayoutAsString()
.- Returns:
- In-app message layout.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CampaignInAppMessage.Builder,
CampaignInAppMessage> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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
-