Anzeigen:
Extends Message
Modul: Core

Eine Instanz von PrivateMessage repräsentiert eine private Nachricht im Chat. Die App erhält sämtliche private Nachrichten, die an einen ihrer BotUser geschickt werden.



Hinweis: Eine App hat keinen Zugriff auf private Nachrichten, die Nutzer untereinander schreiben, ohne dass ein BotUser als Empfänger involviert ist.

Methoden

getAuthor

() User

Geerbt von Message:

Liefert den User, der die Nachricht verfasst hat.

Rückgabewert:

User:

Beispiel:

var author = message.getAuthor(); // i.e.: User:someAwesomeNick

getCreationDate

() Date

Geerbt von Message:

Liefert den genauen Zeitpunkt, zu dem die Nachricht erstellt wurde.

Rückgabewert:

Date:

Beispiel:

var creationDate = message.getCreationDate();

getRawText

() String

Geerbt von Message:

Liefert den Text der Nachricht wie ihn der Nutzer ursprünglich eingegeben hat. Bei vom System generierten Nachrichten (Bots und AppBots) ist dies identisch mit getText().

Rückgabewert:

Beispiel:

var text = message.getText(); // i.e.: 'Hey °>sm_10...b.pw_18.ph_18.gif<>--<>|/tb-show sid~smileyClick:3<°'
var rawText = message.getRawText(); // i.e.: 'Hey :-D'

getReceivingUsers

() User[]

Liefert die Liste der Empfänger der Nachricht.

Rückgabewert:

Beispiel:

var receivingUsers = privateMessage.getReceivingUsers(); // i.e.: [ User:Holgi ]

getText

() String

Geerbt von Message:

Liefert den verarbeiteten Text der Nachricht. Dabei werden unerlaubte KCode-Elemente entfernt und Smileys durch die entsprechenden Bilder ersetzt.

Rückgabewert:

Beispiel:

var text = message.getText(); // i.e.: 'Hey, du bist toll!'

sendReply

(
  • text
)

Sendet eine private Nachricht an alle Beteiligten des Gespräches.

Parameter:

Beispiel:

if (privateMessage.getText().contains('Pizza'))
{
    var msg = 'Gute Idee, ' + privateMessage.getAuthor() + '! Wir sollten Pizza essen.';
    
    privateMessage.sendReply(msg);
}