Anzeigen:
Modul: Channel

Ein Channel ist ein Raum in dem die App läuft.

Die Instanz für den Channel erhält man über das KnuddelsServer-Objekt mit KnuddelsServer.getChannel()

Methoden

getAllUsersWithTalkPermission

(
  • channelTalkPermission
)
User[]

Liefert alle User, die bestimmte ChannelTalkPermissions haben.

Parameter:

Rückgabewert:

Beispiel:

var users = channel.getAllUsersWithTalkPermission(ChannelTalkPermission.Moderator, ChannelTalkPermission.VIP);

getChannelConfiguration

() ChannelConfiguration

Gibt Zugriff auf das ChannelConfiguration-Objekt des Channels.

Rückgabewert:

Beispiel:

var channelConfiguration = channel.getChannelConfiguration();

getChannelDesign

() ChannelDesign

Verfügbar ab Revision AppServer 87470, ChatServer 87470

Gibt Zugriff auf das ChannelDesign-Objekt des Channels.

Rückgabewert:

Beispiel:

var channelDesign = channel.getChannelDesign();

getChannelName

() String

Liefert den Namen des Channels.

Rückgabewert:

Beispiel:

var message = 'Hey ' + user.getNick() + ', willkommen im Channel ' + channel.getChannelName() + '!';

user.sendPrivateMessage(message);

getChannelRestrictions

() ChannelRestrictions

Gibt Zugriff auf das ChannelRestrictions-Objekt des Channels.

Rückgabewert:

Beispiel:

var channelRestrictions = channel.getChannelRestrictions();

getOnlineUsers

(
  • [userType]
)
User[]

Gibt Zugriff auf Nutzer, die gerade im Channel online sind.

Parameter:

  • [userType] UserType optional multiple

    Liste von UserType nach denen gefiltert werden soll.

Rückgabewert:

Beispiel:

var onlineUsers = KnuddelsServer.getChannel().getOnlineUsers();
var humanOnlineUsers = KnuddelsServer.getChannel().getOnlineUsers(UserType.Human);

getRootChannelName

() String

Liefert den Namen des Root-Channels (nur relevant, falls die App Tochterchannel haben kann).

Rückgabewert:

Beispiel:

var rootChannelName = channel.getRootChannelName();

getTalkMode

() ChannelTalkMode

Liefert den ChannelTalkMode, in dem sich der Channel gerade befindet.

Rückgabewert:

Beispiel:

var channelTalkMode = channel.getTalkMode(); // i.e.: ChannelTalkMode.Everyone

getVideoChannelData

() VideoChannelData

Liefert die VideoChannelData des Channels.

Rückgabewert:

Beispiel:

var videoChannelData = channel.getVideoChannelData();

isVideoChannel

() Boolean

Liefert die Information, ob in diesem Channel Videos gestreamt werden können.

Rückgabewert:

Beispiel:

var isVideoChannel = channel.isVideoChannel(); // i.e.: false

isVisible

() Boolean

Verfügbar ab Revision AppServer 82202

Liefert die Information, ob der Channel sichtbar (true) oder unsichtbar (false) ist.

Rückgabewert:

Beispiel:

var isVisible = channel.isVisible();