Class InAppTemplateResponse

    • Method Detail

      • arn

        public final String arn()

        The resource arn of the template.

        Returns:
        The resource arn of the template.
      • 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 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.
      • content

        public final List<InAppMessageContent> content()

        The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

        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:
        The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
      • creationDate

        public final String creationDate()

        The creation date of the template.

        Returns:
        The creation date of the template.
      • 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 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.
      • customConfig

        public final Map<String,​String> 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.
      • lastModifiedDate

        public final String lastModifiedDate()

        The last modified date of the template.

        Returns:
        The last modified date of the template.
      • layout

        public final Layout layout()

        The layout of the message.

        If the service returns an enum value that is not available in the current SDK version, layout will return Layout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from layoutAsString().

        Returns:
        The layout of the message.
        See Also:
        Layout
      • layoutAsString

        public final String layoutAsString()

        The layout of the message.

        If the service returns an enum value that is not available in the current SDK version, layout will return Layout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from layoutAsString().

        Returns:
        The layout of the message.
        See Also:
        Layout
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final Map<String,​String> tags()

        A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

        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 hasTags() method.

        Returns:
        A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
      • templateDescription

        public final String templateDescription()

        The description of the template.

        Returns:
        The description of the template.
      • templateName

        public final String templateName()

        The name of the template.

        Returns:
        The name of the template.
      • version

        public final String version()

        The version id of the template.

        Returns:
        The version id of the template.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)