Package org.exoplatform.agenda.model

Record Class MailInvitation

java.lang.Object
java.lang.Record
org.exoplatform.agenda.model.MailInvitation
Record Components:
username - the user who asked, the only person the landing acts for
attendeeAddress - the address of the user's own mailbox, the one the invitation names them by; may be null
method - the iTIP method as the reader read it, upper-cased, null when the object names none
uid - the event's UID, as the reader read it
recurrenceId - the RECURRENCE-ID as written when the mail is about one occurrence, null for a series or a single event
sequence - the SEQUENCE as the reader read it
response - the answer given, null when the user only asked to add or remove the event
icalendar - the iCalendar object, as text
fromOrganizer - whether the mail reader established that the mail is from the event's organiser (its From is the ORGANIZER's address alone): without it, an event the user holds is never changed or removed
public record MailInvitation(String username, String attendeeAddress, String method, String uid, String recurrenceId, int sequence, org.exoplatform.agenda.constant.EventAttendeeResponse response, String icalendar, boolean fromOrganizer) extends Record
A calendar invitation a user received by mail and wants in their eXo calendar — answered, added as it is, or removed because its organiser cancelled it (EXO-90866). Agenda's own words for what the mail reader hands over, so that only the plugin bridging the two add-ons names the reader's types.

Every field but username is the sender's content or was read from it: a claim, not a fact.

  • Field Details

  • Constructor Details

    • MailInvitation

      public MailInvitation(String username, String attendeeAddress, String method, String uid, String recurrenceId, int sequence, org.exoplatform.agenda.constant.EventAttendeeResponse response, String icalendar, boolean fromOrganizer)
      Creates an instance of a MailInvitation record class.
      Parameters:
      username - the value for the username record component
      attendeeAddress - the value for the attendeeAddress record component
      method - the value for the method record component
      uid - the value for the uid record component
      recurrenceId - the value for the recurrenceId record component
      sequence - the value for the sequence record component
      response - the value for the response record component
      icalendar - the value for the icalendar record component
      fromOrganizer - the value for the fromOrganizer record component

  • Method Details

    • isCancellation

      public boolean isCancellation()
      Whether the message is its organiser's cancellation.
      Returns:
      true for a CANCEL

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • username

      public String username()
      Returns the value of the username record component.
      Returns:
      the value of the username record component

    • attendeeAddress

      public String attendeeAddress()
      Returns the value of the attendeeAddress record component.
      Returns:
      the value of the attendeeAddress record component

    • method

      public String method()
      Returns the value of the method record component.
      Returns:
      the value of the method record component

    • uid

      public String uid()
      Returns the value of the uid record component.
      Returns:
      the value of the uid record component

    • recurrenceId

      public String recurrenceId()
      Returns the value of the recurrenceId record component.
      Returns:
      the value of the recurrenceId record component

    • sequence

      public int sequence()
      Returns the value of the sequence record component.
      Returns:
      the value of the sequence record component

    • response

      public org.exoplatform.agenda.constant.EventAttendeeResponse response()
      Returns the value of the response record component.
      Returns:
      the value of the response record component

    • icalendar

      public String icalendar()
      Returns the value of the icalendar record component.
      Returns:
      the value of the icalendar record component

    • fromOrganizer

      public boolean fromOrganizer()
      Returns the value of the fromOrganizer record component.
      Returns:
      the value of the fromOrganizer record component