public interface NotificationParameters
Modifier and Type | Method and Description |
---|---|
NotificationParameters |
setNotifyByEmailOnly(boolean emailOnly)
Choose if this notification sends to user's email only.
|
NotificationParameters |
setRecipientsByGroups(List<Group> recipientGroups)
Sets the List of Groups who will receive the notification.
|
NotificationParameters |
setRecipientsByPersonIds(Set<String> recipientPersonIds)
Sets the Person (
person__sys ) record ids who will receive the notification. |
NotificationParameters |
setRecipientsByRecordRoles(List<RecordRole> recipientRecordRoles)
Sets the List of RecordRoles who will receive the notification.
|
NotificationParameters |
setRecipientsByUserIds(Set<String> recipientIds)
Sets the recipients who will receive the notification.
|
NotificationParameters |
setSenderId(String senderId)
Sets the sender ID to provide values for sender tokens used in a notification template or message.
|
NotificationParameters setRecipientsByUserIds(Set<String> recipientIds)
If any invalid userIds are set as recipients, an error will occur when NotificationService.send() is called with this NotificationParameters.
If any inactive userIds are set as recipients, they are ignored when NotificationService.send() is called with this NotificationParameters.
recipientIds
- Set of notification recipients' user idsNotificationParameters setRecipientsByGroups(List<Group> recipientGroups)
If any Group in the List is null, an error will occur when NotificationService.send() is called with this NotificationParameters.
If any Group contains inactive userIds, those inactive userIds are ignored when NotificationService.send() is called with this NotificationParameters.
recipientGroups
- List of Groups to receive the notificationNotificationParameters setRecipientsByRecordRoles(List<RecordRole> recipientRecordRoles)
If any RecordRole in the List is null, an error will occur when NotificationService.send() is called with this NotificationParameters.
If any RecordRole contains inactive userIds, those inactive usersIds are ignored when NotificationService.send() is called with this NotificationParameters.
recipientRecordRoles
- List of RecordRoles to receive the notificationNotificationParameters setRecipientsByPersonIds(Set<String> recipientPersonIds)
person__sys
) record ids who will receive the notification. Additive to the recipient UserIds,
Groups, and RecordRoles.
Persons are treated as external users and cannot receive in-application notifications. Person recipients will only
receive email notifications to the email address found in each Person record's standard email__sys
field. Emails to Persons use the external email template rather than the Vault user email template.
If any invalid personIds are set as recipients, an error will occur when NotificationService.send() is called with this NotificationParameters.
If any inactive personIds are set as recipients, they are ignored when NotificationService.send() is called with this NotificationParameters.
If any personIds without an email address are set as recipients, they are ignored when NotificationService.send() is called with this NotificationParameters.
recipientPersonIds
- Set of Person (person__sys) record ids to receive the notification.NotificationParameters setSenderId(String senderId)
Sender tokens include:
senderFirstName
: The sender's first name.senderLastName
: The sender's last name.senderName
: The sender's full name, including first and last.senderUserName
: The sender's user name (login credentials).senderMobilePhone
: The sender's mobile phone number.senderOfficePhone
: The sender's office phone number.senderEmail
: The sender's email.senderTitle
: The sender's title.If an invalid or inactive userId is set as the sender, an error will occur when NotificationService.send() is called with this NotificationParameters.
senderId
- the sender's user idNotificationParameters setNotifyByEmailOnly(boolean emailOnly)
emailOnly
- true if email only; false for both email and notification in Vault Home (default)Copyright © Veeva Systems 2017–2019. All rights reserved.