com.flowable.engage.conversation.api

Interface ConversationUserQuery

All Known Implementing Classes:

ConversationUserQueryImpl

public interface ConversationUserQuery

A participant query object can be obtained through ConversationService.createConversationUserQuery() and can be used to query for participant information within a conversation. By default, all participants are returned, also including indirect participants joined over a group (e.g. assigned group or candidate groups) unless one of the specific option is chosen.

Author:

Micha Kiener

Method Summary

Modifier and Type	Method and Description
ConversationUserQuery	addAll() This will return all users involved within a conversation, including directly assigned participants, owners and assignees as well as indirectly involved users through group memberships.
ConversationUserQuery	addAssignedGroupMembers() Includes all group members of the assigned group of the conversation.
ConversationUserQuery	addAssignedUsers() Includes all directly assigned users (e.g.
ConversationUserQuery	addCandidateGroupMembers() Includes all group members of all candidate groups of the conversation.
ConversationUserQuery	addParticipantUsers() Includes all participants of the conversation.
ConversationUserQuery	conversationId(String conversationId) The id of the conversation to request users for must be provided through its id.
long	count() Counts the number of user ids according the query.
ConversationUserQuery	includeHistoricParticipants() Includes participants that are not part of the current conversation, but have been part in the past.
List<String>	list() Returns the list of user ids according the query.

Method Detail

conversationId

ConversationUserQuery conversationId(String conversationId)

The id of the conversation to request users for must be provided through its id.

Parameters:

conversationId - the id of the conversation to request users for

Returns:

the query builder for chaining

addAll

ConversationUserQuery addAll()

This will return all users involved within a conversation, including directly assigned participants, owners and assignees as well as indirectly involved users through group memberships.

Returns:

the query builder for chaining

addAssignedUsers

ConversationUserQuery addAssignedUsers()

Includes all directly assigned users (e.g. owner and assignee) of the conversation.

Returns:

the query builder for chaining

addParticipantUsers

ConversationUserQuery addParticipantUsers()

Includes all participants of the conversation.

Returns:

the query builder for chaining

addAssignedGroupMembers

ConversationUserQuery addAssignedGroupMembers()

Includes all group members of the assigned group of the conversation.

Returns:

the query builder for chaining

addCandidateGroupMembers

ConversationUserQuery addCandidateGroupMembers()

Includes all group members of all candidate groups of the conversation.

Returns:

the query builder for chaining

includeHistoricParticipants

ConversationUserQuery includeHistoricParticipants()

Includes participants that are not part of the current conversation, but have been part in the past.

Returns:

the query builder for chaining

count

long count()

Counts the number of user ids according the query.

Returns:

the total user count

list

List<String> list()

Returns the list of user ids according the query.

Returns:

the list of user ids