senselogic.sitevision.api.message

Interface ChannelWrapper

All Superinterfaces:

Wrapper<Node>

public interface ChannelWrapper
extends Wrapper<Node>

Channel administration interface.

This wrapper provides methods to update an existing channel (node of type sv:topic).

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

Since:

Sitevision 2024.03.01

Author:

Elias Abrache

Method Summary

Modifier and Type	Method and Description
boolean	addMember(Node aUserIdentity) Adds a user identity as member of the wrapped channel.
boolean	isMember(Node aUserIdentity) Checks if a user identity is a member of the wrapped channel.
boolean	removeMember(Node aUserIdentity) Removes a member from the wrapped channel.
boolean	renameChannel(String aChannelName) Alters the name of the wrapped channel.
boolean	setChannelDescription(String aChannelDescription) Alters the description of the wrapped channel.

Methods inherited from interface senselogic.sitevision.api.base.Wrapper

unwrap

Method Detail

addMember

boolean addMember(Node aUserIdentity)

Adds a user identity as member of the wrapped channel.

Requires enabled Social collaboration, and for the operating user to have a social user identity.

Only non-members will be added, i.e. a user identity that already is a member will be ignored. Channels that are archived don't accept any new members.

Permission notes!

Open channels require the operating user to have either membership or the PermissionUtil.Permission.MANAGE_CHANNELS permission when adding members other than self.

Private channels require the operating user to have membership.

Parameters:

aUserIdentity - a user identity (or user)

Returns:

true if aUserIdentity was added as member of the wrapped channel, false otherwise. false is always returned if aUserIdentity is null or already a member of the wrapped channel.

removeMember

boolean removeMember(Node aUserIdentity)

Removes a member from the wrapped channel.

Only members can be removed, i.e. a user identity that is a non-member will be ignored. Members can not be removed from channels that are archived.

Permission notes!

Open channels require the operating user to have one of the following:

• PermissionUtil.Permission.MANAGE_CHANNELS permission.
• Be channel administrator (author of the channel).
• Operating user matches the user identity (i.e. "is yourself").

Private channels require the operating user to have one of the following:

• Membership and the PermissionUtil.Permission.MANAGE_CHANNELS permission.
• Be channel administrator (author of the channel).
• Operating user matches the user identity (i.e. "is yourself").

Parameters:

aUserIdentity - a user identity (or user)

Returns:

true if aUserIdentity was removed as member from the wrapped channel, false otherwise. false is always returned if aUserIdentity is null or not a member of the wrapped channel.

isMember

boolean isMember(Node aUserIdentity)

Checks if a user identity is a member of the wrapped channel.

Parameters:

aUserIdentity - a user identity (or user)

Returns:

true if aUserIdentity is a member of the wrapped channel, false otherwise. false is always returned if aUserIdentity is null.

Since:

Sitevision 2024.05.01

renameChannel

boolean renameChannel(String aChannelName)

Alters the name of the wrapped channel.

Permission note Only the author or members with the PermissionUtil.Permission.MANAGE_CHANNELS permission can alter the channel name.

The new channel name most not exceed 80 characters in length and must be unique otherwise false will be returned.

Parameters:

aChannelName - the new name of the channel

Returns:

true if channel could be renamed to aChannelName, false otherwise.

Since:

Sitevision 2024.05.01

setChannelDescription

boolean setChannelDescription(String aChannelDescription)

Alters the description of the wrapped channel.

Permission note Only the author or members with the PermissionUtil.Permission.MANAGE_CHANNELS permission can alter the channel description.

Parameters:

aChannelDescription - the new description of the channel

Returns:

true if channel description was set to aChannelDescription, false otherwise.

Since:

Sitevision 2024.05.01