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 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.
      • getSenderName

        String getSenderName()
        Optional, but recommended that you set this. The name of the sender. Defaults to the display name of getSender()
        Returns:
        The name of the sender.
        See Also:
        getSender()
      • isAnswerAllowed

        boolean isAnswerAllowed()
        Returns:
        Whether the recipient is allowed to answer the form record message.