Interface MessageComponents.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MessageComponents.Builder,MessageComponents>, SdkBuilder<MessageComponents.Builder,MessageComponents>, SdkPojo
Enclosing class:
MessageComponents
@Mutable @NotThreadSafe public static interface MessageComponents.Builder extends SdkPojo, CopyableBuilder<MessageComponents.Builder,MessageComponents>

  • Method Details

    • headline

      MessageComponents.Builder headline(String headline)

      A sentence long summary. For example, titles or an email subject line.

      Parameters:
      headline - A sentence long summary. For example, titles or an email subject line.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • paragraphSummary

      MessageComponents.Builder paragraphSummary(String paragraphSummary)

      A paragraph long or multiple sentence summary. For example, Chatbot notifications.

      Parameters:
      paragraphSummary - A paragraph long or multiple sentence summary. For example, Chatbot notifications.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completeDescription

      MessageComponents.Builder completeDescription(String completeDescription)

      A complete summary with all possible relevant information.

      Parameters:
      completeDescription - A complete summary with all possible relevant information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      MessageComponents.Builder dimensions(Collection<Dimension> dimensions)

      A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

      Included dimensions, keys, and values are subject to change.

      Parameters:
      dimensions - A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

      Included dimensions, keys, and values are subject to change.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      MessageComponents.Builder dimensions(Dimension... dimensions)

      A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

      Included dimensions, keys, and values are subject to change.

      Parameters:
      dimensions - A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

      Included dimensions, keys, and values are subject to change.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      MessageComponents.Builder dimensions(Consumer<Dimension.Builder>... dimensions)

      A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

      Included dimensions, keys, and values are subject to change.

      This is a convenience method that creates an instance of the Dimension.Builder avoiding the need to create one manually via Dimension.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dimensions(List<Dimension>).

      Parameters:
      dimensions - a consumer that will call methods on Dimension.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: