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()

 

HomeServerConnector._MessageArchive~getDataCallback

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()

 

HomeServerConnector._MessageArchive~getMetaCallback

Abstract types

inner

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

[
   {
      "ts":    Number,
      "token": String,
      "text":  String
   }
]

Erklärung

  • ts - Unix-Zeitstempel (in Sekunden, Millisekunden als Kommawert) des Eintrags.
  • token - Im Experte definiertes Kürzel des Eintrags.
  • text - Im Experte definierter Text des Eintrags.
inner

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

{ 
  "keys":        Array of String,
  "caption":     String,
  "description": String,
  "tags":        Array of String,
  "size":        Number,
  "tokens":      Array of String
}

Erklärung

  • keys - Liste mit Schlüsseln (z.B.: ["MA:3", "MA@MeinArchiv"]). Enthält mindestens einen Eintrag.
  • caption - Bezeichnung des Objekts.
  • description - Beschreibung des Objekts.
  • tags - Liste von Tags (z.B.: ["EG", "BWM"]).
  • size - Maximale Größe des Ringpuffers.
  • tokens - Liste aller möglichen Kürzel (Meldungen).