Interface VisualMessageConfiguration.Builder

  • Method Details

    • enabled

      Specifies whether the custom message is displayed on the visual. When set to true, the custom message appears in place of the default message. When set to false or omitted, the default message is displayed.

      Parameters:
      enabled - Specifies whether the custom message is displayed on the visual. When set to true, the custom message appears in place of the default message. When set to false or omitted, the default message is displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • title

      The title text of the message that is displayed on the visual.

      Parameters:
      title - The title text of the message that is displayed on the visual.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • titleVisibility

      VisualMessageConfiguration.Builder titleVisibility(String titleVisibility)

      Specifies whether the title of the message is displayed.

      Parameters:
      titleVisibility - Specifies whether the title of the message is displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • titleVisibility

      VisualMessageConfiguration.Builder titleVisibility(Visibility titleVisibility)

      Specifies whether the title of the message is displayed.

      Parameters:
      titleVisibility - Specifies whether the title of the message is displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • description

      VisualMessageConfiguration.Builder description(String description)

      The description text of the message that is displayed on the visual.

      Parameters:
      description - The description text of the message that is displayed on the visual.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • descriptionVisibility

      VisualMessageConfiguration.Builder descriptionVisibility(String descriptionVisibility)

      Specifies whether the description of the message is displayed.

      Parameters:
      descriptionVisibility - Specifies whether the description of the message is displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • descriptionVisibility

      VisualMessageConfiguration.Builder descriptionVisibility(Visibility descriptionVisibility)

      Specifies whether the description of the message is displayed.

      Parameters:
      descriptionVisibility - Specifies whether the description of the message is displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • linkText

      The display text of the hyperlink that is shown in the message.

      Parameters:
      linkText - The display text of the hyperlink that is shown in the message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • linkUrl

      The destination URL of the hyperlink that is shown in the message. Only valid http, https, and mailto URLs are supported.

      Parameters:
      linkUrl - The destination URL of the hyperlink that is shown in the message. Only valid http, https, and mailto URLs are supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • linkVisibility

      VisualMessageConfiguration.Builder linkVisibility(String linkVisibility)

      Specifies whether the hyperlink in the message is displayed.

      Parameters:
      linkVisibility - Specifies whether the hyperlink in the message is displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • linkVisibility

      VisualMessageConfiguration.Builder linkVisibility(Visibility linkVisibility)

      Specifies whether the hyperlink in the message is displayed.

      Parameters:
      linkVisibility - Specifies whether the hyperlink in the message is displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: