Interface AppointmentPickerApiSelect

Stellt Funktionen bereit, die sich auf das Abrufen von Daten aus einem Terminwähler beziehen, wie den ausgewählten Slot oder ob der Wähler geöffnet / geschlossen ist.

Verfügbar über $.xutil.appointmentPicker.get.

Hierarchy

  • AppointmentPickerApiSelect

Index

Properties

appointmentTemplate

appointmentTemplate: function

Ermittelt die Terminvorlage für den ersten Terminwähler anhand der angegebenen Referenz.

Jeder Terminwähler ist mit einer Terminvorlage verknüpft, die im Backend konfiguriert werden kann.

param

Eine Referenz auf den Terminwähler, aus dem die Typ-UUID gelesen werden soll.

returns

Die Terminvorlage des Terminwählers.

Type declaration

appointmentType

appointmentType: function

Ermittelt die Terminvorlage für den ersten Terminwähler anhand der angegebenen Referenz.

Jeder Terminwähler ist mit einer Terminvorlage verknüpft, die im Backend konfiguriert werden kann.

param

Eine Referenz auf den Terminwähler, aus dem die Typ-UUID gelesen werden soll.

returns

Die Terminvorlage des Terminwählers.

Type declaration

date

date: function

Ermittelt das aktuell ausgewählte Datum des ersten Terminwählers anhand der angegebenen Referenz.

Gibt undefined zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

param

Eine Referenz auf den Terminwähler, aus dem das ausgewählte Datum gelesen werden soll.

returns

Das aktuell ausgewählte Datum oder undefined, wenn kein Datum ausgewählt ist.

Type declaration

disabledDates

disabledDates: function

Gibt eine Liste aller deaktivierten Datumsbereiche zurück, für den ersten Terminwähler anhand der angegebenen Referenz.

Deaktivierte Daten können vom Benutzer nicht ausgewählt werden. Beachten Sie, dass Daten ohne verfügbare Slots normalerweise auch als deaktiviert angezeigt werden, aber nicht in das Ergebnis dieser Funktion einbezogen werden.

param

Eine Referenz auf den Terminwähler, der verarbeitet werden soll.

param

Bereiche von Daten, die aktiviert werden sollen.

returns

Eine Liste der deaktivierten Daten.

Type declaration

isDateDisabled

isDateDisabled: function

Überprüft, ob das angegebene Datum für den ersten Terminwähler aus der angegebenen Referenz deaktiviert ist.

Deaktivierte Daten können vom Benutzer nicht ausgewählt werden. Beachten Sie, dass Daten ohne verfügbare Slots normalerweise auch als deaktiviert angezeigt werden, aber nicht in das Ergebnis dieser Funktion einbezogen werden.

param

Eine Referenz auf den Terminwähler, der verarbeitet werden soll.

param

Ein Datum, das überprüft werden soll.

returns

Ob das angegebene Datum deaktiviert ist.

Type declaration

isLocked

isLocked: function

Überprüft, ob der Terminwähler gesperrt ist, für den ersten Terminwähler aus der angegebenen Referenz.

Der Terminwähler ist gesperrt, wenn er deaktiviert oder schreibgeschützt ist und nicht bearbeitet werden kann.

Gibt false zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

param

Eine Referenz auf den Terminwähler, für den überprüft werden soll, ob er gesperrt ist.

returns

true, wenn der Terminwähler gesperrt ist, oder false sonst.

Type declaration

isOpened

isOpened: function

Überprüft, ob der Terminwähler geöffnet oder geschlossen ist, für den ersten Terminwähler aus der angegebenen Referenz.

Gibt false zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

param

Eine Referenz auf den Terminwähler, für den überprüft werden soll, ob er geöffnet ist.

returns

true, wenn der Terminwähler geöffnet ist, oder false sonst. Gibt immer true zurück, wenn der Terminwähler nicht schließbar ist.

Type declaration

lock

lock: function

Ermittelt den Sperrzustand des Terminwählers für den ersten Terminwähler anhand der angegebenen Referenz.

Der Terminwähler ist gesperrt, wenn er deaktiviert oder schreibgeschützt ist und nicht bearbeitet werden kann.

Dies ist ähnlich wie isLocked, enthält jedoch Informationen darüber, ob der Terminwähler deaktiviert oder schreibgeschützt ist.

Gibt enabled zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

param

Eine Referenz auf den Terminwähler, für den der Sperrmodus abgerufen werden soll.

returns

Der Sperrzustand des Terminwählers.

monthYear

monthYear: function

Ermittelt den aktuell angezeigten Monat im Kalender für den ersten Terminwähler anhand der angegebenen Referenz.

Gibt undefined zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

param

Eine Referenz auf den Terminwähler, aus dem der aktuell angezeigte Monat gelesen werden soll.

returns

Der aktuell angezeigte Monat und das Jahr oder der aktuelle Monat und das Jahr, wenn die Referenz nicht auf Terminwähler verweist.

Type declaration

options

options: function

Ruft die Optionen des ersten Terminwählers anhand der angegebenen Referenz ab.

Gibt undefined zurück, wenn die angegebene Referenz nicht auf einen vorhandenen Terminwähler zeigt.

param

Eine Referenz auf den Terminwähler, aus dem die Optionen abgerufen werden sollen.

returns

Optionen des Terminwählers.

Type declaration

persistedAppointment

persistedAppointment: function

Ruft den gespeicherten Termin, falls vorhanden, für den ersten Terminwähler aus der angegebenen Referenz ab.

Jeder Terminwähler kann mit einem Termin verknüpft sein, der auf dem Server gebucht wurde, normalerweise zuvor, als das Formular zum ersten Mal übermittelt wurde. Normalerweise werden ausgewählte Slots, die nicht mit einem verfügbaren Slot übereinstimmen, als ungültig behandelt. Wenn ein ausgewählter Slot mit dem gespeicherten Slot übereinstimmt, ist diese Auswahl immer zulässig.

param

Eine Referenz auf den Terminwähler, für den der gespeicherte Slot abgerufen werden soll.

returns

Der gespeicherte Slot oder undefined, wenn kein solcher Slot vorhanden ist.

slot

slot: function

Ruft den aktuell ausgewählten Slot des ersten Terminwählers anhand der angegebenen Referenz ab.

Gibt undefined zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

param

Eine Referenz auf den Terminwähler, aus dem der ausgewählte Slot abgerufen werden soll.

returns

Der aktuell ausgewählte Slot oder undefined, wenn kein Slot ausgewählt ist.

Type declaration

slotStartDate

slotStartDate: function

Ruft das Startdatum des aktuell ausgewählten Slots des ersten Terminwählers aus der angegebenen Referenz ab. Das Ergebnis wird als JavaScript-Datumsobjekt zurückgegeben.

Gibt undefined zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

param

Eine Referenz auf den Terminwähler, aus dem der ausgewählte Slot abgerufen werden soll.

returns

Das Startdatum des aktuell ausgewählten Slots oder undefined, wenn kein Slot ausgewählt ist.

Type declaration