Package 

Interface MessagePreviewFormatter

  • 
public interface MessagePreviewFormatter

    An interface that allows to generate a preview text for the given message.

    • Method Summary

      Modifier and Type Method Description
      abstract AnnotatedString formatMessageTitle(Message message) Generates a preview title for the given message.
      abstract AnnotatedString formatMessagePreview(Message message, User currentUser) Generates a preview text for the given message.
      abstract AnnotatedString formatDraftMessagePreview(DraftMessage draftMessage) Generates a preview text for the given draft message.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • formatMessageTitle

         abstract AnnotatedString formatMessageTitle(Message message)

        Generates a preview title for the given message.

        Parameters:
        message - The message whose data is used to generate the preview title.

      • formatMessagePreview

         abstract AnnotatedString formatMessagePreview(Message message, User currentUser)

        Generates a preview text for the given message.

        Parameters:
        message - The message whose data is used to generate the preview text.
        currentUser - The currently logged in user.

      • formatDraftMessagePreview

         abstract AnnotatedString formatDraftMessagePreview(DraftMessage draftMessage)

        Generates a preview text for the given draft message. This is used to show a preview of the draft message in the the channel list.

        Parameters:
        draftMessage - The draft message whose data is used to generate the preview text.