Class ImageResponseCard

    • Method Detail

      • title

        public final String title()

        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

        Returns:
        The title to display on the response card. The format of the title is determined by the platform displaying the response card.
      • subtitle

        public final String subtitle()

        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

        Returns:
        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
      • imageUrl

        public final String imageUrl()

        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

        Returns:
        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
      • hasButtons

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

        public final List<Button> buttons()

        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

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

        Returns:
        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
      • 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)