senselogic.sitevision.api.message

Interface MessagesFactory

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

Factory for creating messages-related instances.

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

Since:

Sitevision 2024.03.1

Author:

Elias Abrache

Method Summary

Modifier and Type	Method and Description
ChannelUtil	getChannelUtil() Gets an instance of a channel utility class.
ChannelWrapper	getChannelWrapper(Node aChannel) Gets a wrapper for the specified channel.
DirectMessageUtil	getDirectMessageUtil() Gets an instance of a direct message utility class.

Method Detail

getChannelUtil

ChannelUtil getChannelUtil()

Gets an instance of a channel utility class.

Returns:

a channel utility class

Since:

Sitevision 2024.05.1

getChannelWrapper

ChannelWrapper getChannelWrapper(Node aChannel)

Gets a wrapper for the specified channel.

Parameters:

aChannel - the channel node (node of type sv:topic).

Returns:

a channel wrapper for aChannel, or null if aChannel isn't a channel, is archived, Social Collaboration isn't activated or operating user doesn't have a social user identity.

getDirectMessageUtil

DirectMessageUtil getDirectMessageUtil()

Gets an instance of a direct message utility class.

Returns:

a direct message utility class

Since:

Sitevision 2025.04.1