Message/message

From KWICK! Developer Wiki

Jump to: navigation, search

Contents

Beschreibung

Aufzurufende Url: /message/?PAGE/?FOLDER

Hinweis: In der Url mit einem ? (Fragezeichen) gekennzeichnete Pfade sind optionale Parameter, welche nicht bei jedem Aufruf erforderlich sind. Beachte bitte, dass die Reihenfolge der Parameter in jedem Fall eingehalten werden muss.

Soll beispielswiese der zweite optionale Parameter verwendet werden, so muss der Erste zwangsläufig mit angegeben werden, damit die Reihenfolge erhalten bleibt.

Liefert den Inhalt eines Message-Ordners. Der Platzhalter ?FOLDER steht hierbei für den gewählten Ordner, sowie der Platzhalter ?PAGE für die anzufragende Seite.

Mögliche Werte für den Platzhalter ?FOLDER sind recv, sent, parked und spam.

Parameter

Keine.

Rückgabe

Name Beschreibung
page Aktuell abgefragte Seite. Die erste Seite ist Seite 0, die zweite 1, und so weiter.
maxPage Die Maximale Seitennummer, falls es mehrere Seiten gibt. Bei 5 Seiten beispielsweise 4.
counter sum Gesamtzahl aller empfangenen Messages.
recv Anzahl der normalen empfangenen Messages.
send Anzahl der gesendeten Messages.
parked Anzahl der geparkten empfangenen Messages.
spam Anzahl der als Spam markierten empfangenen Messages.
messages msgs Ein JSON-Array, welches für jede Message ein JSON-Objekt mit folgenden Werten enthält.
Name Beschreibung
msgid Eindeutige Message-ID.
channel Nummer des Nachrichtenkanals, über den kommuniziert wird.
user userid Eindeutige Mitglieds-ID des Gesprächspartners.
username Mitgliedsname des Gesprächspartners.
sex Geschlecht, 1 für weiblich oder 2 für männlich.
age Alter des Gesprächspartners in Jahren.
birtday Geburtsdatum des Gesprächspartners nach ISO 8601 im Format JJJJ-MM-TT.
has_pic Wenn kein Bild vorhanden ist 0, wenn das Bild gesperrt ist -1, andernfalls der UNIX-Zeitstempel des aktuellen Mitgliedsbildes.
city Ort des Gesprächspartners.
isBuddy True, wenn der Gesprächspartner ein Freund ist, andernfalls false.
status Online-Status des Gesprächspartners. Die folgenden Werte sind möglich.
Wert Beschreibung
0 Offline
1 Online
2 Abwesend
3 Bitte nicht stören!
4 Unsichtbar
6 Will chatten
pic Absolute URL zum Profilbild des Gesprächspartners im Format 50 x 50 Pixel.
history Ein JSON-Array, welches für jeden Eintrag in der History ein JSON-Objekt mit folgenden Werten enthält.
Name Beschreibung
date Datum und Uhrzeit des Eintrages als UNIX-Zeitstempel.
sender Eindeutige Mitglieds-ID des Absenders der Message.
text Inhalt der Message.
vcard Visitenkarte (vcard) des Absenders. Siehe User/username.
msgCount Anzahl der Messages im angezeigten Ordner.
selected Ausgewählter Message-Ordner.

Fehler-Rückgabe

Es ist darauf zu achten, dass stets Ordnernamen angegeben werden die existieren, sowie bei der Angabe des Platzhalter ?PAGE stets im Rahmen der existierenden Seiten, also zwischen 0 und maxPage geblättert wird, da andernfalls ein leeres Ergebnis zurückgegeben wird.

Personal tools