Interface ISendMessageRequest
-
- All Superinterfaces:
Serializable
public interface ISendMessageRequest extends Serializable
Common interface for the request to send message.- Since:
- 8.4.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotBlank String
getFormRecordUuid()
@NotNull @Valid ISendMessageData
getMessage()
@NotNull ISendMessageRecipient
getRecipient()
@NotNull IUser
getSender()
Required.@NotBlank String
getSenderContext()
Required.String
getSenderName()
Optional, but recommended that you set this.boolean
isAnswerAllowed()
-
-
-
Method Detail
-
getFormRecordUuid
@NotBlank @NotBlank String getFormRecordUuid()
- Returns:
- The UUID (or process ID) of the form record for which the message is sent.
-
getMessage
@NotNull @Valid @NotNull @Valid ISendMessageData getMessage()
- Returns:
- The message of the form record message request.
-
getRecipient
@NotNull @NotNull ISendMessageRecipient getRecipient()
- Returns:
- The recipient of the form record message.
-
getSender
@NotNull @NotNull IUser getSender()
Required. The user who sent the message. Defaults to anonymous.- Returns:
- The user who sent the message.
-
getSenderContext
@NotBlank @NotBlank String getSenderContext()
Required. The context where the message was posted. See alsoEFormRecordMessageSenderContext
for well-known contexts.- Returns:
- The context where the message was posted.
- See Also:
EFormRecordMessageSenderContext
-
getSenderName
String getSenderName()
Optional, but recommended that you set this. The name of the sender. Defaults to the display name ofgetSender()
- Returns:
- The name of the sender.
- See Also:
getSender()
-
isAnswerAllowed
boolean isAnswerAllowed()
- Returns:
- Whether the recipient is allowed to answer the form record message.
-
-