Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    String

    String Klasse

    Diese Dokumentation beschreibt, welche Erweiterungen am serverseitigen String-Objekt vorgenommen wurden.

    Methoden

    capitalize

    () String

    Verfügbar ab Version AppServer 92695

    Liefert den String mit dem ersten Buchstaben als Großbuchstaben.

    Rückgabewert:

    String:

    Beispiel:

    var capitalizedString = 'hallo du.'.capitalize(); // i.e.: 'Hallo du.'

    contains

    (
    • needle
    )
    Boolean

    Liefert die Information, ob ein bestimmter String in diesem String vorhanden ist.

    Parameter:

    Rückgabewert:

    Boolean:

    Beispiel:

    var message = 'Kekse sind toll, Pizza ist toller!';

if (message.contains('Pizza'))
{
    // Do something...
}

    endsWith

    (
    • suffix
    )
    Boolean

    Diese Methode liefert die Information, ob der String auf dem die Methode aufgerufen wurde mit einem bestimmten Suffix endet.

    Parameter:

    • suffix String

      der überprüft werden soll

    Rückgabewert:

    Boolean:

    true, wenn der String mit suffix endet.

    Beispiel:

    var message = 'Hi du!';

if (message.endsWith('!'))
{
    // Do something...
}

    escapeKCode

    () String

    Die Methode liefert den String zurück, auf dem sie aufgerufen wurde mit KCode escaped.

    Rückgabewert:

    String:

    KCode escaped

    Beispiel:

    'Herzchen <3'.escapeKCode(); // 'Herzchen \<3'

    getPixelWidth

    (
    • fontSize
    • isBold
    )
    Number

    Liefert die Breite des Strings in der Schriftart Arial mit der gegeben Schriftgröße und Information, ob Text fett dargestellt werden soll.

    Parameter:

    Rückgabewert:

    Number:

    Beispiel:

    var message = 'Hey du! Cool, dass du da bist.';

var pixelWidth = message.getPixelWidth(12, false); // 164

    hasOnlyAlphanumericalAndWhitespaceCharacters

    () Boolean

    Verfügbar ab Version AppServer 82271

    Liefert die Information, ob der String nur aus Zeichen besteht, die alphanumerisch + Whitespaces sind.

    Rückgabewert:

    Boolean:

    Beispiel:

    var alphaOrWhite = 'Es ist gut'.hasOnlyAlphanumericalAndWhitespaceCharacters(); // i.e.: true

    hasOnlyDigits

    () Boolean

    Verfügbar ab Version AppServer 82271

    Liefert die Information, ob der String nur aus Zeichen besteht, die Nummern sind.

    Rückgabewert:

    Boolean:

    Beispiel:

    var onlyDigits = '0913'.hasOnlyDigits(); // i.e.: true

    hasOnlyNicknameCharacters

    () Boolean

    Verfügbar ab Version AppServer 82271

    Liefert die Information, ob der String nur aus Zeichen besteht, die in einem Nicknamen vorkommen dürfen. undefined, null, sowie der Leerstring oder ein String, der nur aus Leerzeichen besteht, liefern alle false zurück. Nicknamen dürfen nicht mit Leerzeichen anfangen oder enden, dies, sowie einige andere Restriktionen für Nicknamen, werden von dieser Methode jedoch nicht geprüft.

    Rückgabewert:

    Boolean:

    Beispiel:

    var hasOnlyNicknameCharacters = 'ABC!'.hasOnlyNicknameCharacters(); // i.e.: false

    isAllowedAsChatMessage

    () Boolean

    Prüft primitiv, ob der String laut Knuddels-Filterregeln als Nachricht für den Chat in Ordnung ist.

    Rückgabewert:

    Boolean:

    Beispiel:

    var isOk = 'Matratze'.isAllowedAsChatMessage(); // i.e.: true

    isAllowedAsNick

    () Boolean

    Prüft primitiv, ob der String laut Knuddels-Filterregeln als Nick in Ordnung ist. Kann verwendet werden wenn in der App andere Nicks als im Chat verwendet werden sollen.

    Rückgabewert:

    Boolean:

    Beispiel:

    var isOk = 'Matratze'.isAllowedAsNick(); // i.e.: false

    isEmpty

    () Boolean

    Verfügbar ab Version AppServer 92695

    Liefert die Information, ob der String leer oder null ist.

    Rückgabewert:

    Boolean:

    Beispiel:

    var isEmpty = ''.isEmpty(); // i.e.: true

    isOk

    () Boolean Veraltet

    Verfügbar ab Version ChatServer 82262, AppServer 82262

    Veraltet: Es sollten isAllowedAsNick() oder isAllowedAsChatMessage() genutzt werden.

    Prüft primitiv, ob der String laut Knuddels-Filterregeln ok ist.

    Rückgabewert:

    Boolean:

    Beispiel:

    var isOk = 'Arsch'.isOk(); // i.e.: false

    limitString

    (
    • fontSize
    • isBold
    • maxPixelWidth
    • [abbreviationMarker]
    )
    String

    Liefert einen String, der in der Schriftart Arial mit der gegeben Schriftgröße und Information, ob Text fett dargestellt werden soll maximal maxPixelWidth breit ist. Wird der Text dafür gekürzt, so wird an das Ende abbreviationMarker angehangen. Falls abbreviationMarker nicht übergeben wurde, so ist es automatisch '...'.

    Parameter:

    Rückgabewert:

    String:

    Beispiel:

    var message = 'Hallo du, ich möchte dir etwas sagen, aber ich weiss nicht genau was.';

message.limitString(12, true, 50); // 'Hallo d...'

    minimalConversionCost

    (
    • otherString
    )
    Number

    Verfügbar ab Version AppServer 82271

    Liefert die Levenshtein-Distanz zum übergebenen String. Levenshtein-Distanz: Minimale Anzahl von Einfüge-, Lösch- und Ersetz-Operationen, um die erste Zeichenkette in die zweite umzuwandeln.

    Parameter:

    Rückgabewert:

    Number:

    Beispiel:

    var minimalConversionCost = 'Sascha'.minimalConversionCost('Pascha'); // i.e.: 1

    replaceAll

    (
    • search
    • replacement
    )
    String

    Erstellt eine Kopie des String, in dem alle Vorkommnisse des String search in replacement ersetzt werden und liefert diesen zurück.

    Parameter:

    Rückgabewert:

    String:

    Beispiel:

    var text = 'Ich habe Hunger, Hunger, Hunger.';
text.replaceAll('ger', 'de'); // Ich habe Hunde, Hunde, Hunde.

    replaceAll

    (
    • regexp
    • replacement
    )
    String

    Erstellt eine Kopie des String, in dem alle Vorkommnisse des regulären Ausdrucks regexp in replacement ersetzt werden und liefert diesen zurück.

    Parameter:

    Rückgabewert:

    String:

    Beispiel:

    var text = 'Ich habe Hunggger, Hunggeerr, HUNGGEEEERRRRR.';
text.replaceAll(/g+e+r+/i, 'de'); // Ich habe Hunde, Hunde, HUNde.

    startsWith

    (
    • prefix
    )
    Boolean

    Diese Methode liefert die Information, ob der String auf dem die Methode aufgerufen wurde mit einem bestimmten Prefix beginnt.

    Parameter:

    • prefix String

      der überprüft werden soll

    Rückgabewert:

    Boolean:

    true, wenn der String mit prefix beginnt.

    Beispiel:

    var message = 'Hi du!';

if (message.startsWith('Hi'))
{
    // Do something...
}

    stripKCode

    () String

    Entfernt jeglichen KCode aus dem String und gibt ihn zurück.

    Rückgabewert:

    String:

    Beispiel:

    var message = 'Huhu °>James|/w "|/pp "<°! °>sm_01.gif<°';

message.stripKCode(); // 'Huhu James! ';

    toCamelCase

    () String

    Verfügbar ab Version AppServer 92695

    Liefert den String in CamelCase.

    Rückgabewert:

    String:

    Beispiel:

    var camelCaseString = 'Ich bin ein Star'.toCamelCase(); // i.e.: 'IchBinEinStar'