Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    ChannelInformation

    ChannelInformation Klasse

    Modul: Channel

    Ermöglicht Zugriff auf textuelle Channelinformationen und persistente Änderungen.

    Übersicht

    Methoden

    Methoden

    getTopic

    () String

    Liefert das eingestellte Thema des Channels.

    Rückgabewert:

    String:

    Beispiel:

    var channel = KnuddelsServer.getChannel();
var channelConfiguration = channel.getChannelConfiguration();
var channelInformation = channelConfiguration.getChannelInformation();

var currentTopic = channelInformation.getTopic();

    setTopic

    (
    • topic
    • showMessage
    )

    Aktualisiert das Thema das Channels.

    Parameter:

    • topic String

      darf maximal 2.500 Zeichen lang sein, andernfalls wird eine Exception geworfen.

    • showMessage Boolean

      entscheidet, ob die Änderung des Topics live für alle Nutzer angezeigt werden soll true oder nur bei neuen Logins aktualisiert sein soll false.

    Beispiel:

    var channel = KnuddelsServer.getChannel();
var channelConfiguration = channel.getChannelConfiguration();
var channelInformation = channelConfiguration.getChannelInformation();

channelInformation.setTopic('Der beste Spieler in dieser Stunde heisst Plex');