Removing participants from a conversation
Depending on your use case for Unblu, you may want to allow participants in a conversation to remove other participants.
Configuration
Removing participants is configured in the CONVERSATION or CONVERSATION_TEMPLATE scope. This lets you define the permission differently for different types of conversation.
First, enable the participant removal feature by setting com.unblu.conversation.participation.enableParticipantBasedRemoveConfiguration to true.
Next, specify who may remove other participants. This permission is granted based on the participant role of both the participant being removed and the participant doing the removing. The configuration properties in question are:
Each configuration property specifies the participant roles that may remove a participant with a particular role from the conversation. Note that participants can’t remove themselves from a conversation, so including the assigned agent in the value of com.unblu.conversation.participation.allowRemoveAssignedAgent, for example, doesn’t have an effect.
| The configuration property com.unblu.conversation.ui.removeParticipant, which granted more limited control over removing participants, was deprecated in version 8.25.0 of Unblu Spark. Use the properties described above instead. |
Usage
-
In the Agent Desk, the button to remove a participant is available in two places:
-
The participant information popup that’s displayed when the agent clicks a participant’s avatar in the upper left-hand corner of the conversation panel
-
-
In visitor UIs, the Remove participant button is accessible by clicking the avatar of the participant to be removed.
Because participants don’t appear as avatars or participants in their own UIs, they can’t remove themselves from a conversation. They can, however, leave a conversation, provided their participant role is allowed to do so.
Behavior
-
When the assigned agent is removed, all secondary agents are removed from the conversation as well. If com.unblu.conversation.lifecycle.enableUnassignedState is
true, the conversation state changes toUNASSIGNED; if it’sfalse, the conversation ends. -
When the context person is removed, secondary visitors remain in the conversation as secondary visitors. The conversation continues without a context person unless com.unblu.conversation.lifecycle.autoEndOnLeave includes the context person. In the latter case, the conversation ends.
See also
-
As mentioned above, users can leave a conversation if their participant role is allowed to do so. For information on leaving a conversation, refer to Leave conversation and End conversation buttons in the UI customization guide.
-
For information on how to remove participants in the Agent Desk, refer to the description in the Agent Desk guide.
-
For information on how to remove participants in the Floating Visitor UI, refer to Additional Floating Visitor UI controls in the Floating Visitor UI guide.