Knuddels User Apps - API Dokumentation

  • Dokumentation für Version 20240419-122957 (ChatServer: 20240419-122957)

    • Knuddels
    User App Entwicklung
    API Dokumentation
    ChannelRestrictions

    ChannelRestrictions Klasse

    Modul: Channel

    Eine Instanz von ChannelRestrictions ermöglicht es, aktuelle Informationen über Nutzungsbeschränkungen im Channel zu erhalten.

    Die Instanz für die ChannelRestrictions erhält man über das Channel-Objekt mit channel.getChannelRestrictions()

    Methoden

    getColorMutedUsers

    () User[]

    Liefert alle User die im Channel derzeit für das Nutzen von Farben, Textformatierung und Smileys in öffentlichen Nachrichten gesperrt sind.

    Rückgabewert:

    User[]:

    Beispiel:

    var colorMutedUsers = channelRestrictions.getColorMutedUsers();

if (colorMutedUsers.length == 0)
{
    user.sendPrivateMessage('Derzeit darf jeder im Channel Farben und Smileys verwenden.');
}
else
{
    var message = 'Folgende Nutzer dürfen momentan keine Farben und Smileys verwenden:'
    
    colorMutedUsers.forEach(function(colorMutedUser) 
    {
        var escapedNick = colorMutedUser.getNick().escapeKCode();
        
        message += '°#>ColorMute für ' + escapedNick + ' aufheben|/cmute !' + escapedNick + '<°';
    });
    
    user.sendPrivateMessage(message);
}

    getLockedUsers

    () User[]

    Liefert alle User die für das Betreten des Channel derzeit gesperrt sind.

    Rückgabewert:

    User[]:

    Beispiel:

    var lockedUsers = channelRestrictions.getLockedUsers();

if (lockedUsers.length == 0)
{
    user.sendPrivateMessage('Derzeit darf jeder den Channel betreten.');
}
else
{
    var message = 'Folgende Nutzer dürfen den Channel derzeit nicht betreten:'
    
    lockedUsers.forEach(function(LockedUser) 
    {
        var escapedNick = LockedUser.getNick().escapeKCode();
        
        message += '°#>ChannelLock für ' + escapedNick + ' aufheben|/cl !' + escapedNick + '<°';
    });
    
    user.sendPrivateMessage(message);
}

    getMutedUsers

    () User[]

    Liefert alle User die im Channel derzeit für das Schreiben öffentlicher Nachrichten gesperrt sind.

    Rückgabewert:

    User[]:

    Beispiel:

    var mutedUsers = channelRestrictions.getMutedUsers();

if (mutedUsers.length == 0)
{
    user.sendPrivateMessage('Derzeit darf jeder im Channel öffentlich schreiben.');
}
else
{
    var message = 'Folgende Nutzer sind derzeit für das öffentliche Schreiben im Channel gesperrt:'
    
    mutedUsers.forEach(function(mutedUser) 
    {
        var escapedNick = mutedUser.getNick().escapeKCode();
        
        message += '°#>Mute für ' + escapedNick + ' aufheben|/mute !' + escapedNick + '<°';
    });
    
    user.sendPrivateMessage(message);
}