Package com.flowable.engage.message.api

Interface MessageAudit

All Known Subinterfaces:
MessageAuditEntity
All Known Implementing Classes:
MessageAuditEntityImpl
public interface MessageAudit
Author:
Filip Hrisafov

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getConversationId()
    The id of the conversation that this media audit belongs to
    java.util.Date getCreationTime()
    The creation time of this version of the message.
    java.lang.String getCreatorId()
    The id of the user that created this version of the message.
    java.lang.String getId()
    The unique, technical id of the audit message
    java.lang.String getMainContent()
    The main content of the audit.
    java.lang.String getMainContentType()
    The main content type of the audit.
    java.lang.String getMediaContentId()
    The id of the media content in this audit.
    java.lang.String getMessageId()
    The message id that this audit belongs to
    java.lang.String getModifierId()
    The id of the user that did the modification
    java.util.Date getModifyTime()
    The time of the modification.

  • Method Details

    • getId

      java.lang.String getId()
      The unique, technical id of the audit message
      Returns:
      the id of this object

    • getMessageId

      java.lang.String getMessageId()
      The message id that this audit belongs to
      Returns:
      the message id

    • getMediaContentId

      java.lang.String getMediaContentId()
      The id of the media content in this audit.
      Returns:
      the optional id of a media content

    • getConversationId

      java.lang.String getConversationId()
      The id of the conversation that this media audit belongs to
      Returns:
      the conversation id

    • getMainContent

      java.lang.String getMainContent()
      The main content of the audit.
      Returns:
      the main content

    • getMainContentType

      java.lang.String getMainContentType()
      The main content type of the audit.
      Returns:
      the main content type

    • getCreationTime

      java.util.Date getCreationTime()
      The creation time of this version of the message. This would be either the creation time of a Message or the update time of a Message if the message is being changed multiple times.

      e.g.

      • User 1 creates a message at Time 1
      • User 2 edits the message at Time 2
      • User 3 edits the message again at Time 3

      There will be 2 message audit entries. With the following information:

      • creationTime: Time 1, modifyTime: Time 2
      • creationTime: Time 2, modifyTime: Time 3

      The Message.getUpdaterId() will have User 3

      Returns:
      the creation time of the message version

    • getCreatorId

      java.lang.String getCreatorId()
      The id of the user that created this version of the message. This would be either the creator of a Message or the updater of a Message if the message is being changed multiple times

      e.g.

      • User 1 creates a message
      • User 2 edits the message
      • User 3 edits the message again

      There will be 2 message audit entries. With the following information:

      • creatorId: User 1, modifierId: User 2
      • creatorId: User 2, modifierId: User 3

      The Message.getUpdaterId() will have User 3

      Returns:
      the id of the message version creator

    • getModifyTime

      java.util.Date getModifyTime()
      The time of the modification.

      e.g.

      • User 1 creates a message at Time 1
      • User 2 edits the message at Time 2
      • User 3 edits the message again at Time 3

      There will be 2 message audit entries. With the following information:

      • creationTime: Time 1, modifyTime: Time 2
      • creationTime: Time 2, modifyTime: Time 3

      The Message.getUpdaterId() will have User 3

      Returns:
      the modification time

    • getModifierId

      java.lang.String getModifierId()
      The id of the user that did the modification

      e.g.

      • User 1 creates a message
      • User 2 edits the message
      • User 3 edits the message again

      There will be 2 message audit entries. With the following information:

      • creatorId: User 1, modifierId: User 2
      • creatorId: User 2, modifierId: User 3

      The Message.getUpdaterId() will have User 3

      Returns:
      the user id of the modifier