Package ch.ivyteam.ivy.notification.business

Interface BusinessNotification

public interface BusinessNotification

Sends a business notification

Examples:

Sends a business notification with the given text to the business case creator

 BusinessNotification
   .create()
   .message().text("Order was delivered")
   .receivers().ofBusinessCase().addCreator()
   .send();
 

Sends a business notification with a text from the CMS to the task activator

 BusinessNotification
   .create()
   .message().fromCms("OrderDelivered")
   .receivers().ofTask().addActivator()
   .send();
 

Since:

11.3

API:

This is a public API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BusinessNotification.Builder
static interface	BusinessNotification.CaseReceiverBuilder
static interface	BusinessNotification.MessageBuilder
static interface	BusinessNotification.ReceiverBuilder
static interface	BusinessNotification.ReceiverOrBuilder
static interface	BusinessNotification.ReceiverOrSendBuilder
static interface	BusinessNotification.TaskReceiverBuilder

Method Summary

Static Methods

Modifier and Type	Method	Description
static BusinessNotification.Builder	create()	Sends a business notification
static BusinessNotification.Builder	createFor(ICase wfCase)	Sends a business notification for the given case

Method Details

create

static BusinessNotification.Builder create()

Sends a business notification

Examples:

Sends a business notification with the given text to the business case creator

 BusinessNotification
   .create()
   .message().text("Order was delivered")
   .receivers().ofBusinessCase().addCreator()
   .send();
 

Sends a business notification with a text from the CMS to the task activator

 BusinessNotification
   .create()
   .message().fromCms("OrderDelivered")
   .receivers().ofTask().addActivator()
   .send();
 

API:

This public API is available in Java.

createFor

static BusinessNotification.Builder createFor(ICase wfCase)

Sends a business notification for the given case

Examples:

Sends a business notification with the given text to the case creator

 ICase wfCase = ...;
 BusinessNotification
   .createFor(wfCase)
   .message().text("Order was delivered")
   .receivers().ofCase().creator()
   .send();
 

Note, that in this case ofCase() and ofBusinessCase() will not return the current case but the case and its business case provided to this method.

# @see #create

API:

This public API is available in Java.