Package org.xwiki.netflux.rest

Interface PageChannelsResource

public interface PageChannelsResource

Exposes the Netflux (real-time communication) channels associated to a wiki page through REST.

Since:

13.9RC1

Version:

$Id: 679aaeb3b1c1b6b475c1159ee53bb60b9a37b932 $

Method Summary

Modifier and Type	Method	Description
List<EntityChannel>	getChannels(String wikiName, String spaceNames, String pageName, List<String> paths, Boolean create)	Returns the channels associated with a given wiki page.

Method Detail

getChannels

List<EntityChannel> getChannels(String wikiName,
                                @Encoded
                                String spaceNames,
                                String pageName,
                                List<String> paths,
                                Boolean create)
                         throws XWikiRestException

Returns the channels associated with a given wiki page.

Parameters:

wikiName - the wiki component of the page reference

spaceNames - the space component of the page reference

pageName - the page name

paths - used to retrieve only the channels mapped to the specified paths

create - whether to create or not the missing channels corresponding to the specified paths

Returns:

the list of found channels

Throws:

XWikiRestException - if retrieving the list of channels fails