Package com.veeva.vault.sdk.api.notification

Interface NotificationService

All Superinterfaces:
Service
public interface NotificationService extends Service
Send Vault notifications.

  • Method Details

    • newNotificationParameters

      NotificationParameters newNotificationParameters()
      Creates a new NotificationParameters object to set the parameters of the notification. For example, it can be used to specify the sender ID, a set of recipient IDs, and whether an in-app notification is displayed in the Vault UI.
      Returns:
      a new NotificationParameters

    • newNotificationTemplate

      NotificationTemplate newNotificationTemplate()
      Creates a new NotificationTemplate object to set the template to use and tokens to resolve for a notification.
      Returns:
      a new NotificationTemplate object

    • newNotificationMessage

      NotificationMessage newNotificationMessage()
      Creates a new NotificationMessage object to set subject, message, notification text, and tokens to use in a notification.
      Returns:
      a new NotificationMessage object

    • send

      void send(NotificationParameters parameters, NotificationMessage message)
      Sends a notification with message content. Any missing or invalid parameters in the NotificationParameters or NotificationMessage are caught here.

      If send() is called before NotificationParameters has set recipients with setRecipientsByUserIds(), setRecipientsByGroups(), or setRecipientsByRecordRoles(), an error will occur.

      If at least one of these setRecipientsBy### methods has been called with a non-null Set/List, an error will not occur.

      Parameters:
      parameters - notification parameters set for the notification
      message - message content

    • send

      void send(NotificationParameters parameters, NotificationTemplate template)
      Sends a notification with pre-defined template content. Any missing or invalid parameters in the NotificationParameters or NotificationTemplate are caught here.

      If send() is called before NotificationParameters has set recipients with setRecipientsByUserIds(), setRecipientsByGroups(), or setRecipientsByRecordRoles(), an error will occur.

      If at least one of these setRecipientsBy### methods has been called with a non-null Set/List, an error will not occur.

      Parameters:
      parameters - notification parameters set for the notification
      template - content from a template