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
Group s 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
RecordRole s 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)
Group
s,
RecordRole
s, and person IDs.
If any invalid user IDs are set as recipients, an error will occur when NotificationService.send()
is
called with this NotificationParameters
.
If any inactive user IDs 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)
Group
s who will receive the notification. Additive to the recipient user IDs,
RecordRole
s, and person IDs.
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 user IDs, those users are ignored when NotificationService.send()
is called with this NotificationParameters
.
recipientGroups
- List of Groups to receive the notificationNotificationParameters setRecipientsByRecordRoles(List<RecordRole> recipientRecordRoles)
RecordRole
s who will receive the notification. Additive to the recipient user IDs,
Group
s, and person IDs.
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 user IDs, those users 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
user IDs, Group
s, and RecordRole
s.
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 person IDs are set as recipients, an error will occur when NotificationService.send()
is
called with this NotificationParameters
.
If any inactive person IDs are set as recipients, they are ignored when NotificationService.send()
is
called with this NotificationParameters
.
If any person IDs 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 user ID 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–2020. All rights reserved.