Package com.flowable.engage.engine.impl.conversation

Class ParticipantJoiningBuilderImpl

java.lang.Object

com.flowable.engage.engine.impl.conversation.ParticipantJoiningBuilderImpl

All Implemented Interfaces:

ParticipantJoiningBuilder

public class ParticipantJoiningBuilderImpl
extends Object
implements ParticipantJoiningBuilder

Default implementation of the joining builder to define the exact time of when to join a set of participants.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected JoinParticipantsData	joinParticipantsData
protected ConversationParticipantBuilder	rootBuilder

Constructor Summary

Constructors

Constructor	Description
ParticipantJoiningBuilderImpl(ConversationParticipantBuilder rootBuilder, JoinParticipantsData joinParticipantsData)

Method Summary

Modifier and Type	Method	Description
ConversationParticipantBuilder	fromBeginning()	Will join the selected participant(s) from the beginning of the conversation.
ConversationParticipantBuilder	fromDefault()	Just use the default behaviour which is ParticipantJoiningBuilder.fromNow() for all conversation types except channels, where the default is ParticipantJoiningBuilder.fromBeginning().
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.
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.
ConversationParticipantBuilder	fromNow()	This will join the new participants as of now so they can only see the new messages after being joined.
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).
ConversationParticipantBuilder	fromTime(Date joiningTime)	Will join the selected participant(s) from the given absolute timestamp.
JoinParticipantsData	getJoinParticipantsData()

Methods inherited from class java.lang.Object

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

Field Detail

rootBuilder

protected final ConversationParticipantBuilder rootBuilder

joinParticipantsData

protected final JoinParticipantsData joinParticipantsData

Constructor Detail

ParticipantJoiningBuilderImpl

public ParticipantJoiningBuilderImpl(ConversationParticipantBuilder rootBuilder,
                                     JoinParticipantsData joinParticipantsData)

Method Detail

fromDefault

public ConversationParticipantBuilder fromDefault()

Description copied from interface: ParticipantJoiningBuilder

Just use the default behaviour which is ParticipantJoiningBuilder.fromNow() for all conversation types except channels, where the default is ParticipantJoiningBuilder.fromBeginning().

Specified by:

fromDefault in interface ParticipantJoiningBuilder

Returns:

the conversation participant (root) builder to continue manage participants

fromNow

public ConversationParticipantBuilder fromNow()

Description copied from interface: ParticipantJoiningBuilder

This will join the new participants as of now so they can only see the new messages after being joined.

Specified by:

fromNow in interface ParticipantJoiningBuilder

Returns:

the conversation participant (root) builder to continue manage participants

fromBeginning

public ConversationParticipantBuilder fromBeginning()

Description copied from interface: ParticipantJoiningBuilder

Will join the selected participant(s) from the beginning of the conversation.

Specified by:

fromBeginning in interface ParticipantJoiningBuilder

Returns:

the conversation participant (root) builder to continue manage participants

fromTime

public ConversationParticipantBuilder fromTime(Date joiningTime)

Description copied from interface: ParticipantJoiningBuilder

Will join the selected participant(s) from the given absolute timestamp.

Specified by:

fromTime in interface ParticipantJoiningBuilder

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

public ConversationParticipantBuilder fromMessage(String messageId)

Description copied from interface: ParticipantJoiningBuilder

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.

Specified by:

fromMessage in interface ParticipantJoiningBuilder

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

public ConversationParticipantBuilder fromPastMessages(int numberOfMessages)

Description copied from interface: ParticipantJoiningBuilder

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).

Specified by:

fromPastMessages in interface ParticipantJoiningBuilder

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

public ConversationParticipantBuilder fromDuration(Duration duration)

Description copied from interface: ParticipantJoiningBuilder

Will join the selected participant(s) from the past in the given duration, so they can read messages from the past.

Specified by:

fromDuration in interface ParticipantJoiningBuilder

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

getJoinParticipantsData

public JoinParticipantsData getJoinParticipantsData()