Class SendMessageInput

java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput
com.kingsrook.qqq.backend.core.model.actions.messaging.SendMessageInput
public class SendMessageInput extends AbstractActionInput
Provider-neutral message input. All rich-message fields are optional. Category, linked record, sender name, locale, and variables without a template are advisory: providers that do not support them silently ignore them. Recipients and senders remain Party values; use MultiParty for multiple parties.

  • Constructor Details

    • SendMessageInput

      public SendMessageInput()

  • Method Details

    • getTo

      public Party getTo()
      Getter for to

    • setTo

      public void setTo(Party to)
      Setter for to

    • withTo

      public SendMessageInput withTo(Party to)
      Fluent setter for to

    • getFrom

      public Party getFrom()
      Getter for from

    • setFrom

      public void setFrom(Party from)
      Setter for from

    • withFrom

      public SendMessageInput withFrom(Party from)
      Fluent setter for from

    • getSubject

      public String getSubject()
      Getter for subject

    • setSubject

      public void setSubject(String subject)
      Setter for subject

    • withSubject

      public SendMessageInput withSubject(String subject)
      Fluent setter for subject

    • getContentList

      public List<Content> getContentList()
      Getter for contentList

    • setContentList

      public void setContentList(List<Content> contentList)
      Setter for contentList

    • withContentList

      public SendMessageInput withContentList(List<Content> contentList)
      Fluent setter for contentList

    • getAttachmentList

      public List<Attachment> getAttachmentList()
      Getter for attachmentList

    • setAttachmentList

      public void setAttachmentList(List<Attachment> attachmentList)
      Setter for attachmentList

    • withAttachmentList

      public SendMessageInput withAttachmentList(List<Attachment> attachmentList)
      Fluent setter for attachmentList

    • withContent

      public SendMessageInput withContent(Content content)

    • addContent

      public void addContent(Content content)

    • withAttachment

      public SendMessageInput withAttachment(Attachment attachment)

    • addAttachment

      public void addAttachment(Attachment attachment)

    • getMessagingProviderName

      public String getMessagingProviderName()
      Getter for messagingProviderName

    • setMessagingProviderName

      public void setMessagingProviderName(String messagingProviderName)
      Setter for messagingProviderName

    • withMessagingProviderName

      public SendMessageInput withMessagingProviderName(String messagingProviderName)
      Fluent setter for messagingProviderName

    • getTemplateName

      public String getTemplateName()
      Getter for templateName. Provider template name. Requires the TEMPLATES capability.

    • setTemplateName

      public void setTemplateName(String templateName)
      Setter for templateName

    • withTemplateName

      public SendMessageInput withTemplateName(String templateName)
      Fluent setter for templateName

    • getVariables

      public Map<String,Serializable> getVariables()
      Getter for variables. Template variables; advisory when no template is selected.

    • setVariables

      public void setVariables(Map<String,Serializable> variables)
      Setter for variables

    • withVariables

      public SendMessageInput withVariables(Map<String,Serializable> variables)
      Fluent setter for variables

    • getIdempotencyKey

      public String getIdempotencyKey()
      Getter for idempotencyKey. Provider deduplication key. Requires the IDEMPOTENCY capability.

    • setIdempotencyKey

      public void setIdempotencyKey(String idempotencyKey)
      Setter for idempotencyKey

    • withIdempotencyKey

      public SendMessageInput withIdempotencyKey(String idempotencyKey)
      Fluent setter for idempotencyKey

    • getCategory

      public String getCategory()
      Getter for category. Conventional values: TRANSACTIONAL, NOTIFICATION, MARKETING, SECURITY. Providers may refuse unknown categories.

    • setCategory

      public void setCategory(String category)
      Setter for category

    • withCategory

      public SendMessageInput withCategory(String category)
      Fluent setter for category

    • getLinkedTableName

      public String getLinkedTableName()
      Getter for linkedTableName. Advisory name of the table associated with this message.

    • setLinkedTableName

      public void setLinkedTableName(String linkedTableName)
      Setter for linkedTableName

    • withLinkedTableName

      public SendMessageInput withLinkedTableName(String linkedTableName)
      Fluent setter for linkedTableName

    • getLinkedRecordId

      public Serializable getLinkedRecordId()
      Getter for linkedRecordId. Advisory identifier of the record associated with this message.

    • setLinkedRecordId

      public void setLinkedRecordId(Serializable linkedRecordId)
      Setter for linkedRecordId

    • withLinkedRecordId

      public SendMessageInput withLinkedRecordId(Serializable linkedRecordId)
      Fluent setter for linkedRecordId

    • getSenderName

      public String getSenderName()
      Getter for senderName. Calling qbit or process name for audit; distinct from the from party.

    • setSenderName

      public void setSenderName(String senderName)
      Setter for senderName

    • withSenderName

      public SendMessageInput withSenderName(String senderName)
      Fluent setter for senderName

    • getLocale

      public String getLocale()
      Getter for locale. Advisory locale for provider rendering.

    • setLocale

      public void setLocale(String locale)
      Setter for locale

    • withLocale

      public SendMessageInput withLocale(String locale)
      Fluent setter for locale

    • withVariable

      public SendMessageInput withVariable(String name, Serializable value)
      Add or replace one variable, initializing the map when needed.

    • withLinkedRecord

      public SendMessageInput withLinkedRecord(String table, Serializable id)
      Fluent setter for the associated table and record identifier.