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

Interface NotificationQueueRequest.Builder

Enclosing interface:

NotificationQueueRequest

public static interface NotificationQueueRequest.Builder

Builder for creating a NotificationQueueRequest object.

Method Summary

Modifier and Type	Method	Description
NotificationQueueRequest	build()	Builds the NotificationQueueRequest.
NotificationQueueRequest.Builder	withNotificationMode(List<NotificationMode> notificationModes)	Sets one or more delivery modes for the notification.
NotificationQueueRequest.Builder	withNotificationQueueMessage(NotificationQueueMessage content)	Attaches message content to the request.
NotificationQueueRequest.Builder	withRecipientsByGroups(List<Group> recipientGroups)	Adds groups as notification recipients.
NotificationQueueRequest.Builder	withRecipientsByPersons(List<String> recipientPersons)	Adds Persons as notification recipients.
NotificationQueueRequest.Builder	withRecipientsByRecordRoles(List<RecordRole> recipientRecordRoles)	Adds record roles as notification recipients.
NotificationQueueRequest.Builder	withRecipientsByUsers(List<String> recipientIds)	Adds users as notification recipients.
NotificationQueueRequest.Builder	withReplyToByPersonId(String replyToPersonId)	Sets the reply-to address based on a Person ID.
NotificationQueueRequest.Builder	withReplyToByUserId(String replyToId)	Sets the reply-to address based on a User ID.
NotificationQueueRequest.Builder	withSenderId(String senderId)	Sets the ID of the sender to appear on the notification.

Method Details

withRecipientsByUsers

NotificationQueueRequest.Builder withRecipientsByUsers(List<String> recipientIds)

Adds users as notification recipients.

Parameters:

recipientIds - list of user IDs to receive the notification

Returns:

this Builder instance

withRecipientsByGroups

NotificationQueueRequest.Builder withRecipientsByGroups(List<Group> recipientGroups)

Adds groups as notification recipients.

Parameters:

recipientGroups - list of Group objects to receive the notification

Returns:

this Builder instance

withRecipientsByRecordRoles

NotificationQueueRequest.Builder withRecipientsByRecordRoles(List<RecordRole> recipientRecordRoles)

Adds record roles as notification recipients.

Parameters:

recipientRecordRoles - list of RecordRole objects to receive the notification

Returns:

this Builder instance

withRecipientsByPersons

NotificationQueueRequest.Builder withRecipientsByPersons(List<String> recipientPersons)

Adds Persons as notification recipients. Person recipients can only receive emails, not in-app notifications. If a person is also a Vault user, you must add them via withRecipientsByUsers(java.util.List) to queue an in-app notification for them.

Parameters:

recipientPersons - list of Person IDs to receive the notification

Returns:

this Builder instance

withSenderId

NotificationQueueRequest.Builder withSenderId(String senderId)

Sets the ID of the sender to appear on the notification.

Parameters:

senderId - user ID of the sender

Returns:

this Builder instance

withReplyToByUserId

NotificationQueueRequest.Builder withReplyToByUserId(String replyToId)

Sets the reply-to address based on a User ID. Setting both a user and a person reply-to recipient via withReplyToByPersonId(String) will cause an error during NotificationService.queueNotification(NotificationQueueRequest).

Parameters:

replyToId - user ID for the reply-to field

Returns:

this Builder instance

withReplyToByPersonId

NotificationQueueRequest.Builder withReplyToByPersonId(String replyToPersonId)

Sets the reply-to address based on a Person ID. Setting both a user and a person reply-to recipient via withReplyToByUserId(String) will cause an error during NotificationService.queueNotification(NotificationQueueRequest).

Parameters:

replyToPersonId - Person ID for the reply-to field

Returns:

this Builder instance

withNotificationMode

NotificationQueueRequest.Builder withNotificationMode(List<NotificationMode> notificationModes)

Sets one or more delivery modes for the notification. For example, EMAIL or APPLICATION. By default, notifications are sent as both an email and an in-app notification.

Parameters:

notificationModes - chosen notification delivery modes

Returns:

this Builder instance

withNotificationQueueMessage

NotificationQueueRequest.Builder withNotificationQueueMessage(NotificationQueueMessage content)

Attaches message content to the request.

Parameters:

content - NotificationQueueMessage defining the content

Returns:

this Builder instance

build

NotificationQueueRequest build()

Builds the NotificationQueueRequest.

Returns:

the configured NotificationQueueRequest