Package com.flowable.engage.conversation.api

Interface ParticipantJoiningBuilder

All Known Implementing Classes:
ParticipantJoiningBuilderImpl
public interface ParticipantJoiningBuilder
Once you start joining a new participant to an existing conversation, there are a lot of options which can be set additionally using this builder API which is returned with one of the join methods in the ConversationParticipantBuilder API.
Author:
Micha Kiener

  • Method Details

    • fromDefault

      ConversationParticipantBuilder fromDefault()
      Just use the default behaviour which is fromNow() for all conversation types except channels, where the default is fromBeginning().
      Returns:
      the conversation participant (root) builder to continue manage participants

    • fromNow

      ConversationParticipantBuilder fromNow()
      This will join the new participants as of now so they can only see the new messages after being joined.
      Returns:
      the conversation participant (root) builder to continue manage participants

    • fromBeginning

      ConversationParticipantBuilder fromBeginning()
      Will join the selected participant(s) from the beginning of the conversation.
      Returns:
      the conversation participant (root) builder to continue manage participants

    • fromTime

      ConversationParticipantBuilder fromTime(Date joiningTime)
      Will join the selected participant(s) from the given absolute timestamp.
      Parameters:
      joiningTime - the time from which the participant(s) will be able to see messages
      Returns:
      the conversation participant (root) builder to continue manage participants

    • fromMessage

      ConversationParticipantBuilder fromMessage(String messageId)
      Will join the selected participant(s) from the time of when the given message was posted, in order to be able to read that message and every one after it.
      Parameters:
      messageId - the id of the message to use as the time when to join the new participants
      Returns:
      the conversation participant (root) builder to continue manage participants

    • fromPastMessages

      ConversationParticipantBuilder fromPastMessages(int numberOfMessages)
      Will join the selected participant(s) from the creation time of x messages back (basically the new participants will be able to read those x messaages).
      Parameters:
      numberOfMessages - the number of messages the new participants will be able to read
      Returns:
      the conversation participant (root) builder to continue manage participants

    • fromDuration

      ConversationParticipantBuilder fromDuration(Duration duration)
      Will join the selected participant(s) from the past in the given duration, so they can read messages from the past.
      Parameters:
      duration - the duration to go into the past to join the new participant(s)
      Returns:
      the conversation participant (root) builder to continue manage participants