new _VacationCalendar()

Urlaubskalender.
Darf nicht direkt instanziert werden. Eine Instanz der Klasse wird von der Methode HomeServerConnector._Connection#getVacationCalendar erzeugt.

Example

var vc = conn.getVacationCalendar("VC@MeinKalender", function(err, data) {});  

Methods

destroy()

Gibt das Objekt frei und hebt ein eventuell vorhandes Abonnement auf.

Example

vc.destroy();

get(callback)

Liefert den Status eines Urlaubskalenders

Example

Abruf des Status.

vc.get(function(err, active, from, to) {});

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._VacationCalendar~getCallback

getKey() → String

Liefert den Schlüssel des Objekts zurück.

Example

var object_key = vc.getKey();
Returns

String 

getMeta(callback)

Ruft die Meta-Daten ab.

Example

Abruf der Meta-Daten.

vc.getMeta(function(err, data) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._VacationCalendar~getMetaCallback

set(active, from, to, callback)

Ändert die Werte eines Urlaubskalenders.

Example

Urlaubskalender setzen.

vc.set(true, new Date(2016, 6, 1), new Date(2016, 6, 31), function(err) {}); // Aktiv von 1.7.2016 bis 31.7.2016

Parameters

Name Type Optional Description

active

Boolean

 

true: der Urlaubskalender ist aktiv.

from

Date

 

Start des Zeitraums.

to

Date

 

Ende des Zeitraums.

callback

function()

 

HomeServerConnector._VacationCalendar~setCallback

Abstract types

inner

getCallback(err, active, from, to)

Example

Abruf des Status.

vc.get(function(err, active, from, to) {});

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

active

Boolean

 

true: der Urlaubskalender ist aktiv.

from

Date

 

Start des Zeitraums.

to

Date

 

Ende des Zeitraums.

inner

getMetaCallback(err, data)

Example

Abruf der Meta-Daten

vc.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,
}

Erklärung

  • keys - Liste mit Schlüsseln (z.B.: ["VC:2", "VC@MeinUKal"]). Enthält mindestens einen Eintrag.
  • caption - Bezeichnung des Objekts.
  • description - Beschreibung des Objekts.
  • tags - Liste von Tags.
inner

setCallback(err)

Example

Urlaubskalender setzen.

vc.set(true, new Date(2016, 6, 1), new Date(2016, 6, 31), function(err) {}); // Aktiv von 1.7.2016 bis 31.7.2016

Parameter

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt