HomeServerConnector. _Sequence
new _Sequence()
Sequenz.
Darf nicht direkt instanziert werden. Eine Instanz der Klasse wird von der Methode
HomeServerConnector._Connection#getSequence erzeugt.
Example
var sq = conn.getSequence("SQ@Sequenz", function(err, data) {});
Methods
destroy()
Gibt das Objekt frei und hebt ein eventuell vorhandes Abonnement auf.
Example
sq.destroy();
getKey() → String
Liefert den Schlüssel des Objekts zurück.
Example
var object_key = sq.getKey();
- Returns
-
String
getMeta(callback)
Ruft die Meta-Daten ab.
Example
Abruf der Meta-Daten.
sq.getMeta(function(err, data) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
getState(callback)
Liefert den Status der Sequenz: Sequenz läuft / läuft nicht
Example
Abruf des Status.
sq.getState(function(err, state) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
start(callback)
Startet eine Sequenz.
Example
Sequenz starten.
sq.start(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
stop(callback)
Stoppt eine laufende Sequenz.
Example
Sequenz anhalten.
sq.stop(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
Abstract types
getMetaCallback(err, data)
Example
Abruf der Meta-Daten.
sq.getMeta(function(err, data) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
data |
Object |
|
Meta-Informationen
Struktur
Erklärung
|
getStateCallback(err, state)
Example
Abruf des Status.
sq.getState(function(err, state) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
state |
Boolean |
|
true: Sequenz läuft - false: Sequenz läuft nicht. |
startCallback(err)
Example
Sequenz starten.
sq.start(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
stopCallback(err)
Example
Sequenz anhalten.
sq.stop(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |