Package ch.ivyteam.ivy.notification.business

Interface BusinessNotification.Builder

All Known Subinterfaces:
BusinessNotification.ReceiverOrBuilder
Enclosing interface:
BusinessNotification
public static interface BusinessNotification.Builder
API:
This is a public API.

  • Method Details

    • template

      BusinessNotification.ReceiverOrBuilder template(String template)

      Use the given notification template to render the notification.

      If not specified the Default template will be used.

      You can define your own templates in your projects CMS under the path /Notification/business/Templates/{channel}/{Subject|Content}.

      For more information about templates read the Concepts>Notification>Templating chapter in the documentation.

      Parameters:
      template -
      Returns:
      builder for further composition of the notification
      API:
      This public API is available in Java.

    • message

      BusinessNotification.MessageBuilder message()

      Define the notification message you want to send

      Returns:
      builder for further composition of the message
      API:
      This public API is available in Java.

    • payload

      BusinessNotification.ReceiverOrBuilder payload(Object payload)

      Use the given payload object to render the notification.

      The payload can be used in the notification template by using the variable payload

      For more information about templates read the Concepts>Notification>Templating chapter in the documentation.

      Parameters:
      payload -
      Returns:
      builder for further composition of the notification
      API:
      This public API is available in Java.