Package com.zendesk.sunshine_conversations_client.model

Class Webview

  • All Implemented Interfaces:
    Action, ActionSubset
    public class Webview
extends java.lang.Object
implements Action, ActionSubset
    When a webview actions is clicked/tapped, the provided URI will be loaded in a webview. Channels that do not support webviews will open the fallback URI instead.

    • Field Detail

      • JSON_PROPERTY_TYPE

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

      • JSON_PROPERTY_URI

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

      • JSON_PROPERTY_TEXT

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

      • JSON_PROPERTY_DEFAULT

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

      • JSON_PROPERTY_METADATA

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

      • JSON_PROPERTY_EXTRA_CHANNEL_OPTIONS

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

      • JSON_PROPERTY_SIZE

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

      • JSON_PROPERTY_FALLBACK

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

      • JSON_PROPERTY_OPEN_ON_RECEIVE

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

    • Constructor Detail

      • Webview

        public Webview()

    • Method Detail

      • type

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

      • getType

        public java.lang.String getType()
        The type of action.
        Specified by:
        getType in interface Action
        Specified by:
        getType in interface ActionSubset
        Returns:
        type

      • setType

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

      • uri

        public Webview uri​(java.lang.String uri)

      • getUri

        public java.lang.String getUri()
        The webview URI. This is the URI that will open in the webview when clicking the button.
        Returns:
        uri

      • setUri

        public void setUri​(java.lang.String uri)

      • text

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

      • getText

        public java.lang.String getText()
        The button text.
        Returns:
        text

      • setText

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

      • _default

        public Webview _default​(java.lang.Boolean _default)

      • getDefault

        @Nullable
public java.lang.Boolean getDefault()
        Boolean value indicating whether the action is the default action for a message item in Facebook Messenger.
        Returns:
        _default

      • setDefault

        public void setDefault​(java.lang.Boolean _default)

      • metadata

        public Webview metadata​(java.lang.Object metadata)

      • getMetadata

        @Nullable
public java.lang.Object getMetadata()
        Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.
        Returns:
        metadata

      • getMetadata_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> getMetadata_JsonNullable()

      • setMetadata_JsonNullable

        public void setMetadata_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> metadata)

      • setMetadata

        public void setMetadata​(java.lang.Object metadata)

      • getExtraChannelOptions

        @Nullable
public ExtraChannelOptions getExtraChannelOptions()
        Get extraChannelOptions
        Returns:
        extraChannelOptions

      • setExtraChannelOptions

        public void setExtraChannelOptions​(ExtraChannelOptions extraChannelOptions)

      • getSize

        @Nullable
public Webview.SizeEnum getSize()
        The size to display a webview. Used for actions of type webview.
        Returns:
        size

      • fallback

        public Webview fallback​(java.lang.String fallback)

      • getFallback

        public java.lang.String getFallback()
        The fallback uri for channels that don’t support webviews. Used for actions of type webview.
        Returns:
        fallback

      • setFallback

        public void setFallback​(java.lang.String fallback)

      • openOnReceive

        public Webview openOnReceive​(java.lang.Boolean openOnReceive)

      • getOpenOnReceive

        @Nullable
public java.lang.Boolean getOpenOnReceive()
        Boolean value indicating if the webview should open automatically. Only one action per message can be set to true. Currently only supported on the Web Messenger.
        Returns:
        openOnReceive

      • setOpenOnReceive

        public void setOpenOnReceive​(java.lang.Boolean openOnReceive)

      • 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