senselogic.sitevision.api.message

Interface DirectMessageUtil

@Requireable(value="DirectMessageUtil")
public interface DirectMessageUtil

Direct Message utility interface.

An instance of the Sitevision class implementing this interface can be obtained via MessagesFactory.getDirectMessageUtil(). See MessagesFactory for how to obtain an instance of the MessagesFactory interface.

Since:

Sitevision 2025.04.1

Author:

Elias Abrache

Method Summary

Modifier and Type	Method and Description
Node	createConversation(Collection<Node> aMembers) Creates a new direct message conversation for the current user identity with the specified members.
Node	getConversation(Collection<Node> aMembers) Retrieves an existing direct message conversation for the current user identity that includes the specified members.

Method Detail

getConversation

Node getConversation(Collection<Node> aMembers)
              throws ConstraintViolationException

Retrieves an existing direct message conversation for the current user identity that includes the specified members. The current user identity is always included in the conversation.

Parameters:

aMembers - array of sv:userIdentity nodes representing other participants in the conversation (including or excluding current user identity, who is always implicitly included as member anyway).

Returns:

a sv:directMessageConversation node representing the direct message conversation for the current user identity, or null if no matching conversation is found.

Throws:

ConstraintViolationException - if social collaboration is not enabled on the site.

IllegalStateException - if current user doesn't have a user identity.

IllegalArgumentException - if aMembers is null or empty. Or if any of the specified members is not a valid conversation participant.

createConversation

Node createConversation(Collection<Node> aMembers)
                 throws ConstraintViolationException

Creates a new direct message conversation for the current user identity with the specified members. If an existing conversation with the same participants (including the current user identity) exists, it will be returned instead of creating a new one.

Parameters:

aMembers - array of sv:userIdentity nodes representing other participants in the conversation (including or excluding current user identity, who is always implicitly included as member anyway).

Returns:

a sv:directMessageConversation node representing the newly created or retrieved direct message conversation for the current user identity.

Throws:

ConstraintViolationException - if social collaboration is not enabled on the site or if the conversation could not be created.

IllegalStateException - if current user doesn't have a user identity.

IllegalArgumentException - if aMembers is null or empty. Or if any of the specified members is not a valid conversation participant.