HomeServerConnector. _MessageArchive
Abstract types
new _MessageArchive()
Meldungsarchiv.
Darf nicht direkt instanziert werden. Eine Instanz der Klasse wird von der Methode
HomeServerConnector._Connection#getMessageArchive erzeugt.
Example
var ma = conn.getMessageArchive("MA@MeldungsArchiv", function(err, data) {});
Methods
destroy()
Gibt das Objekt frei und hebt ein eventuell vorhandes Abonnement auf.
Example
ma.destroy();
getData(_count, callback)
Ruft eine bestimmte Anzahl von Einträgen eines Meldungsarchivs ab. Es werden immer die neuesten Einträge zurückgeliefert.
Example
Abruf der (max.) 10 letzten Einträge.
ma.getData(10, function(err, items) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
_count |
Number |
|
Max. Anzahl an Einträgen, die zurückgeliefert werden sollen. |
callback |
function() |
|
getKey() → String
Liefert den Schlüssel des Objekts zurück.
Example
var object_key = ma.getKey();
- Returns
-
String
getMeta(callback)
Ruft die Meta-Daten ab.
Example
Abruf der Meta-Daten.
ma.getMeta(function(err, data) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
Abstract types
getDataCallback(err, items)
Example
Abruf der (max.) 10 letzten Einträge.
ma.getData(10, function(err, items) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
items |
Array |
|
Liste mit den Daten des Meldungsarchivs. Jeder Eintrag enthält die folgenden Felder:
Struktur
Erklärung
|
getMetaCallback(err, data)
Example
Abruf der Meta-Daten.
ma.getMeta(function(err, data) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
data |
Object |
|
Meta-Informationen
Struktur
Erklärung
|