formcycle 8.3.6 - JavaScript für Formulare
    Bereite Suchindex vor...

    Schnittstelle 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.

    interface AppointmentPickerApiSnapshot {
        discard: (snapshotToken: string) => void;
        restore: (
            picker: AppointmentPickerInstanceReference,
            snapshotToken: string,
            options?: AppointmentPickerRestoreSnapshotOptions,
        ) => void;
        setPersistedAppointment: (
            snapshotToken: string,
            appointment: AppointmentPickerPersistedAppointment,
        ) => string;
        setSlot: (
            snapshotToken: string,
            slot: AppointmentSlot,
            options?: AppointmentPickerSetSlotOptions,
        ) => string;
        take: (picker: AppointmentPickerInstanceReference) => string;
    }
    Index

    Eigenschaften

    discard: (snapshotToken: string) => void

    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.

    restore: (
        picker: AppointmentPickerInstanceReference,
        snapshotToken: string,
        options?: AppointmentPickerRestoreSnapshotOptions,
    ) => void

    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.

    Typendeklaration

    setPersistedAppointment: (
        snapshotToken: string,
        appointment: AppointmentPickerPersistedAppointment,
    ) => string

    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.

    Typendeklaration

      • (
            snapshotToken: string,
            appointment: AppointmentPickerPersistedAppointment,
        ): string
      • Parameter

        • snapshotToken: string

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

        • appointment: AppointmentPickerPersistedAppointment

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

        Rückgabewert string

        Ein Snapshot-Token, das den neuen Snapshot identifiziert.

    take

    setSlot: (
        snapshotToken: string,
        slot: AppointmentSlot,
        options?: AppointmentPickerSetSlotOptions,
    ) => string

    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.

    Typendeklaration

      • (
            snapshotToken: string,
            slot: AppointmentSlot,
            options?: AppointmentPickerSetSlotOptions,
        ): string
      • Parameter

        • snapshotToken: string

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

        • slot: AppointmentSlot

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

        • Optionaloptions: AppointmentPickerSetSlotOptions

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

        Rückgabewert string

        Ein Snapshot-Token, das den neuen Snapshot identifiziert.

    take

    take: (picker: AppointmentPickerInstanceReference) => string

    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.

    Typendeklaration