UserChannelService (Cyclos 4.16.19 Scripting API Documentation)

All Superinterfaces:

Service

All Known Subinterfaces:

UserChannelServiceLocal
```
public interface UserChannelService
extends Service
```
Contains methods to access / view the access of users on channels

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`UserChannelsData`	`getChannelsData(@NotNull UserLocatorVO locator)`	Returns data for viewing / editing the channels access for the given user
`void`	`saveChannels(@NotNull UserLocatorVO locator, @NotNull Set<ChannelVO> channels)`	Saves the channels access for the given user.

- Method Detail
  - getChannelsData
```
UserChannelsData getChannelsData(@NotNull
                                 @NotNull UserLocatorVO locator)
                          throws FrameworkException
```
    Returns data for viewing / editing the channels access for the given user
    
    Throws:
    
    FrameworkException
  - saveChannels
```
void saveChannels(@NotNull
                  @NotNull UserLocatorVO locator,
                  @NotNull
                  @NotNull Set<ChannelVO> channels)
           throws FrameworkException
```
    Saves the channels access for the given user. Only the given channels will be accessible, however, some channels are enforcedly enabled or disabled on configurations. In those cases, those channels will be enabled / disable despite the ones set via this method.
    
    Throws:
    
    FrameworkException