Interface AppointmentPickerApiSnapshot

(fortgeschritten) Stellt Funktionen bereit, die sich auf Snapshots beziehen. Ein Snapshot ist eine eingefrorene Ansicht des Zustands eines Terminwählers zu einem bestimmten Zeitpunkt. Nachdem ein Snapshot aufgenommen wurde, kann der Zustand des Wählers zu diesem Snapshot zu einem späteren Zeitpunkt wiederhergestellt werden.

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

Hierarchy

  • AppointmentPickerApiSnapshot

Index

Properties

Properties

discard

discard: function

Fortgeschrittene Verwendung Verwenden Sie diese Methode nicht, wenn Sie sie nicht verstehen.

Verwirft einen Snapshot, der durch einen Aufruf von take erstellt wurde. Danach kann der Snapshot nicht mehr wiederhergestellt werden.

Type declaration

    • (snapshotToken: string): void

    • Parameters

      • snapshotToken: string

      Returns void

restore

restore: function

Fortgeschrittene Verwendung Verwenden Sie diese Methode nicht, wenn Sie sie nicht verstehen.

Stellt den Zustand aller Terminwähler auf den angegebenen Zustand wieder her, der durch seinen Snapshot-Token identifiziert wird. Dies muss ein Token sein, das von take zurückgegeben wird.

param

Eine Referenz auf die Terminwähler, für die der Snapshot wiederhergestellt werden soll.

param

Ein Token eines vorhandenen Snapshots, der wiederhergestellt werden soll.

param

Optionale Einstellungen, wie der Snapshot wiederhergestellt werden soll.

Type declaration

setPersistedAppointment

setPersistedAppointment: function

Erzeugt einen neuen Snapshot, indem der persistierte Termin gesetzt wird.

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 einem verfügbaren Slot entsprechen, als ungültig behandelt. Wenn ein ausgewählter Slot dem persistierten Slot entspricht, ist diese Auswahl immer zulässig.

Der zurückgegebene Snapshot-Token kann identisch mit dem angegebenen Snapshot-Token sein, wenn die Anfrage zu keiner tatsächlichen Änderung geführt hat.

Wenn der angegebene Snapshot-Token auf einen nicht vorhandenen Snapshot verweist, wird der angegebene Token unverändert zurückgegeben.

param

Ein Token eines vorhandenen Snapshots, aus dem ein neuer Snapshot abgeleitet werden soll.

param

Der neue persistierte Termin, der gesetzt werden soll, undefined, um ihn zu löschen.

returns

Ein Snapshot-Token, das den neuen Snapshot identifiziert.

see

take

Type declaration

setSlot

setSlot: function

Fortgeschrittene Verwendung Verwenden Sie diese Methode nicht, wenn Sie sie nicht verstehen.

Erzeugt einen neuen Snapshot aus einem vorhandenen Snapshot, indem der ausgewählte Slot auf den neuen angegebenen Slot geändert wird. Der bereitgestellte Snapshot-Token muss einer der Tokens sein, die von take erstellt wurden.

Der zurückgegebene Snapshot-Token kann identisch mit dem angegebenen Snapshot-Token sein, wenn die Anfrage zu keiner tatsächlichen Änderung geführt hat.

Wenn der angegebene Snapshot-Token auf einen nicht vorhandenen Snapshot verweist, wird der angegebene Token unverändert zurückgegeben.

param

Ein Token eines vorhandenen Snapshots, aus dem ein neuer Snapshot abgeleitet werden soll.

param

Ein Slot zum Auswählen oder undefined, um den ausgewählten Slot zu löschen.

param

Optionale Einstellungen dafür, wie der Slot ausgewählt wird.

returns

Ein Snapshot-Token, das den neuen Snapshot identifiziert.

see

take

Type declaration

take

take: function

Fortgeschrittene Verwendung Verwenden Sie diese Methode nicht, wenn Sie sie nicht verstehen.

Erstellt einen Snapshot des ersten Terminwählers aus der angegebenen Referenz und gibt einen Token zurück, der später mit restore verwendet werden kann, um den Terminwähler in genau den gleichen Zustand wiederherzustellen.

Der zurückgegebene Token ist nur für die Dauer des globalen Fensterbereichs gültig.

param

Eine Referenz auf den Terminwähler, für den der Snapshot erstellt werden soll.

returns

Ein Token des erstellten Snapshots, das an restore übergeben werden kann.

Type declaration