Package com.zendesk.sunshine_conversations_client.model

Class ImageMessage

  • All Implemented Interfaces:
    Content
    public class ImageMessage
extends java.lang.Object
implements Content
    ImageMessage

    • Field Detail

      • JSON_PROPERTY_TYPE

        public static final java.lang.String JSON_PROPERTY_TYPE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_MEDIA_URL

        public static final java.lang.String JSON_PROPERTY_MEDIA_URL
        See Also:
        Constant Field Values

      • JSON_PROPERTY_MEDIA_TYPE

        public static final java.lang.String JSON_PROPERTY_MEDIA_TYPE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_MEDIA_SIZE

        public static final java.lang.String JSON_PROPERTY_MEDIA_SIZE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ALT_TEXT

        public static final java.lang.String JSON_PROPERTY_ALT_TEXT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_TEXT

        public static final java.lang.String JSON_PROPERTY_TEXT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ACTIONS

        public static final java.lang.String JSON_PROPERTY_ACTIONS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ATTACHMENT_ID

        public static final java.lang.String JSON_PROPERTY_ATTACHMENT_ID
        See Also:
        Constant Field Values

    • Constructor Detail

      • ImageMessage

        public ImageMessage()

    • Method Detail

      • type

        public ImageMessage type​(java.lang.String type)

      • getType

        public java.lang.String getType()
        The type of message.
        Specified by:
        getType in interface Content
        Returns:
        type

      • setType

        public void setType​(java.lang.String type)

      • mediaUrl

        public ImageMessage mediaUrl​(java.net.URI mediaUrl)

      • getMediaUrl

        public java.net.URI getMediaUrl()
        The URL for media, such as an image, attached to the message. <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See <a href=\"https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/\">Configuring private attachments for messaging</a> guide for more details.</aside>
        Returns:
        mediaUrl

      • setMediaUrl

        public void setMediaUrl​(java.net.URI mediaUrl)

      • getMediaType

        @Nullable
public java.lang.String getMediaType()
        The type of media.
        Returns:
        mediaType

      • getMediaSize

        @Nullable
public java.math.BigDecimal getMediaSize()
        The size of the media in bytes.
        Returns:
        mediaSize

      • altText

        public ImageMessage altText​(java.lang.String altText)

      • getAltText

        @Nullable
public java.lang.String getAltText()
        An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value.
        Returns:
        altText

      • setAltText

        public void setAltText​(java.lang.String altText)

      • text

        public ImageMessage text​(java.lang.String text)

      • getText

        @Nullable
public java.lang.String getText()
        The text content of the message. Optional only if actions are provided.
        Returns:
        text

      • setText

        public void setText​(java.lang.String text)

      • getActions

        @Nullable
public java.util.List<Action> getActions()
        Array of message actions.
        Returns:
        actions

      • setActions

        public void setActions​(java.util.List<Action> actions)

      • attachmentId

        public ImageMessage attachmentId​(java.lang.String attachmentId)

      • getAttachmentId

        @Nullable
public java.lang.String getAttachmentId()
        An identifier used by Sunshine Conversations for internal purposes.
        Returns:
        attachmentId

      • setAttachmentId

        public void setAttachmentId​(java.lang.String attachmentId)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object