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

    Schnittstelle AppointmentPickerApiAction

    Stellt Funktionen bereit, die sich auf das Ausführen von Aktionen an einem Terminwähler beziehen, wie das Auswählen eines anderen Slots, das Öffnen / Schließen des Terminwählers oder das Laden verfügbarer Slots.

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

    interface AppointmentPickerApiAction {
        changeDisplay: (picker: any, mode?: ChangeDisplayMode) => void;
        changeLock: (picker: any, mode: ChangeLockMode) => void;
        changeMonthYear: (picker: any, monthYear: LocalMonthYear) => void;
        changeMonthYearToNow: (picker: any) => void;
        changeOptions: (
            picker: any,
            options: Partial<AppointmentPickerOptions>,
        ) => void;
        clearDisabledDates: (picker: any) => void;
        disableDateRanges: (
            picker: any,
            ...ranges: readonly LocalDateRange[],
        ) => void;
        disableDates: (picker: any, ...dates: readonly LocalDate[]) => void;
        disableDatesAfter: (picker: any, maxDate: LocalDate) => void;
        disableDatesBefore: (picker: any, minDate: LocalDate) => void;
        enableDateRanges: (
            picker: any,
            ...ranges: readonly LocalDateRange[],
        ) => void;
        enableDates: (picker: any, ...dates: readonly LocalDate[]) => void;
        enableDatesAfter: (picker: any, maxDate: LocalDate) => void;
        enableDatesBefore: (picker: any, minDate: LocalDate) => void;
        loadAvailableSlots: (
            picker: any,
            monthYear: LocalMonthYear,
        ) => Promise<AppointmentMonthSlotData>;
        moveMonthYearBy: (
            picker: any,
            monthYearDuration: Partial<LocalMonthYearDuration>,
        ) => void;
        selectDate: (
            picker: any,
            date: LocalDate,
            options?: AppointmentPickerSetDateOptions,
        ) => void;
        selectSlot: (
            picker: any,
            slot: AppointmentSlot,
            options?: AppointmentPickerSetSlotOptions,
        ) => void;
        setPersistedAppointment: (
            picker: any,
            appointment: AppointmentPickerPersistedAppointment,
        ) => void;
    }
    Index

    Eigenschaften

    changeDisplay changeLock changeMonthYear changeMonthYearToNow changeOptions clearDisabledDates disableDateRanges disableDates disableDatesAfter disableDatesBefore enableDateRanges enableDates enableDatesAfter enableDatesBefore loadAvailableSlots moveMonthYearBy selectDate selectSlot setPersistedAppointment

    Eigenschaften

    changeDisplay: (picker: any, mode?: ChangeDisplayMode) => void

    Schließt oder öffnet den Terminwähler für alle Terminwähler aus dem angegebenen Verweis.

    Das Schließen des Wählers erfordert, dass er schließbar ist. Andernfalls wird keine Aktion ausgeführt.

    Typendeklaration

      • (picker: any, mode?: ChangeDisplayMode): void

      • Parameter

        • picker: any

          Ein Verweis auf die Terminwähler, die geöffnet oder geschlossen werden sollen.

        • Optionalmode: ChangeDisplayMode

          Wie die Anzeige geändert werden soll. open, um sie zu öffnen (wenn sie noch nicht geöffnet ist), close, um sie zu schließen (wenn sie nicht bereits geschlossen ist), und toggle (oder undefined), um sie zu öffnen, wenn sie geschlossen ist, und zu schließen, wenn sie geöffnet ist.

        Rückgabewert void

    changeLock: (picker: any, mode: ChangeLockMode) => void

    Ändert den Sperrzustand des Terminwählers für alle Terminwähler aus dem angegebenen Verweis.

    Wenn der Wähler aktiviert ist, kann er vom Benutzer bearbeitet werden. Wenn er deaktiviert oder schreibgeschützt ist, kann er vom Benutzer nicht mehr bearbeitet werden, aber sein Wert kann immer noch über Skripting geändert werden.

    Deaktivierte oder schreibgeschützte Terminwähler sind immer geschlossen und können nicht geöffnet werden.

    Typendeklaration

      • (picker: any, mode: ChangeLockMode): void

      • Parameter

        • picker: any

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

        • mode: ChangeLockMode

        Rückgabewert void

    changeMonthYear: (picker: any, monthYear: LocalMonthYear) => void

    Zeigt einen bestimmten Monat in einem bestimmten Jahr an und zeigt alle Tage für den Monat für alle Terminwähler aus dem angegebenen Verweis an.

    Typendeklaration

      • (picker: any, monthYear: LocalMonthYear): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, für den der Monat und das Jahr im Kalender angezeigt werden sollen.

        • monthYear: LocalMonthYear

          Ein Monat und Jahr, die im Kalender angezeigt werden sollen.

        Rückgabewert void

    changeMonthYearToNow: (picker: any) => void

    Wählt den aktuellen Monat des aktuellen Jahres aus und zeigt alle Tage für den Monat für alle Terminwähler aus dem angegebenen Verweis an.

    Typendeklaration

      • (picker: any): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, für den der Monat und das Jahr im Kalender angezeigt werden sollen.

        Rückgabewert void

    changeOptions: (picker: any, options: Partial<AppointmentPickerOptions>) => void

    Setzt die Optionen für alle Terminwähler aus dem angegebenen Verweis.

    Typendeklaration

      • (picker: any, options: Partial<AppointmentPickerOptions>): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, für den die Optionen festgelegt werden sollen.

        • options: Partial<AppointmentPickerOptions>

          Die zu setzenden Optionen.

        Rückgabewert void

    clearDisabledDates: (picker: any) => void

    Entfernt alle deaktivierten Termine, sodass keine weiteren Termine deaktiviert sind, für alle Terminwähler aus dem angegebenen Verweis.

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

    Typendeklaration

      • (picker: any): void

      • Parameter

        • picker: any

          Ein Verweis auf die Terminwähler, für die die deaktivierten Termine gelöscht werden sollen.

        Rückgabewert void

    disableDateRanges: (picker: any, ...ranges: readonly LocalDateRange[]) => void

    Fügt der Liste der deaktivierten Datumsbereiche eine Liste von Datumsbereichen hinzu, für alle Terminwähler aus dem angegebenen Verweis.

    Diese Daten sind additiv. Sie können mehrere Bereiche von deaktivierten Daten hinzufügen.

    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.

    Typendeklaration

      • (picker: any, ...ranges: readonly LocalDateRange[]): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, der verarbeitet werden soll.

        • ...ranges: readonly LocalDateRange[]

          Datumsbereiche, die deaktiviert werden sollen.

        Rückgabewert void

    disableDates: (picker: any, ...dates: readonly LocalDate[]) => void

    Deaktiviert die angegebenen Termine für alle Terminwähler aus dem angegebenen Verweis.

    Diese Termine sind additiv. Sie können mehrere deaktivierte Termine hinzufügen.

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

    Typendeklaration

      • (picker: any, ...dates: readonly LocalDate[]): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, der verarbeitet werden soll.

        • ...dates: readonly LocalDate[]

          Liste der Termine, die deaktiviert werden sollen.

        Rückgabewert void

    disableDatesAfter: (picker: any, maxDate: LocalDate) => void

    Deaktiviert alle Termine nach dem angegebenen Datum für alle ersten Terminwähler aus dem angegebenen Verweis.

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

    Typendeklaration

      • (picker: any, maxDate: LocalDate): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, der verarbeitet werden soll.

        • maxDate: LocalDate

        Rückgabewert void

    disableDatesBefore: (picker: any, minDate: LocalDate) => void

    Deaktiviert alle Termine vor dem angegebenen Datum für alle ersten Terminwähler aus dem angegebenen Verweis.

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

    Typendeklaration

      • (picker: any, minDate: LocalDate): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, der verarbeitet werden soll.

        • minDate: LocalDate

          Minimales erlaubtes Datum, alle Termine vor diesem Datum sind deaktiviert.

        Rückgabewert void

    enableDateRanges: (picker: any, ...ranges: readonly LocalDateRange[]) => void

    Entfernt eine Liste von Datumsbereichen aus der Liste der deaktivierten Datumsbereiche für alle Terminwähler aus dem angegebenen Verweis.

    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.

    Typendeklaration

      • (picker: any, ...ranges: readonly LocalDateRange[]): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, der verarbeitet werden soll.

        • ...ranges: readonly LocalDateRange[]

          Datumsbereiche, die aktiviert werden sollen.

        Rückgabewert void

    enableDates: (picker: any, ...dates: readonly LocalDate[]) => void

    Aktiviert die angegebenen Termine für alle Terminwähler aus dem angegebenen Verweis.

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

    Typendeklaration

      • (picker: any, ...dates: readonly LocalDate[]): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, der verarbeitet werden soll.

        • ...dates: readonly LocalDate[]

          Liste der Termine, die aktiviert werden sollen.

        Rückgabewert void

    enableDatesAfter: (picker: any, maxDate: LocalDate) => void

    Aktiviert alle Termine nach dem angegebenen Datum für alle ersten Terminwähler aus dem angegebenen Verweis.

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

    Typendeklaration

      • (picker: any, maxDate: LocalDate): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, der verarbeitet werden soll.

        • maxDate: LocalDate

        Rückgabewert void

    enableDatesBefore: (picker: any, minDate: LocalDate) => void

    Aktiviert alle Termine vor dem angegebenen Datum für alle ersten Terminwähler aus dem angegebenen Verweis.

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

    Typendeklaration

      • (picker: any, minDate: LocalDate): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, der verarbeitet werden soll.

        • minDate: LocalDate

          Minimales erlaubtes Datum, alle Termine vor diesem Datum sind aktiviert.

        Rückgabewert void

    loadAvailableSlots: (
        picker: any,
        monthYear: LocalMonthYear,
    ) => Promise<AppointmentMonthSlotData>

    Lädt die verfügbaren Termine eines bestimmten Monats und Jahres für den ersten Terminwähler aus dem angegebenen Verweis.

    Typendeklaration

      • (picker: any, monthYear: LocalMonthYear): Promise<AppointmentMonthSlotData>

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, für den die verfügbaren Termine geladen werden sollen.

        • monthYear: LocalMonthYear

          Ein Monat und Jahr, für die die Termine geladen werden sollen.

        Rückgabewert Promise<AppointmentMonthSlotData>

        Alle verfügbaren Termine für den angegebenen Monat und das angegebene Jahr.

    moveMonthYearBy: (
        picker: any,
        monthYearDuration: Partial<LocalMonthYearDuration>,
    ) => void

    Ändert den Monat und das Jahr des Kalenders um den angegebenen Betrag für alle Terminwähler aus dem angegebenen Verweis.

    Typendeklaration

      • (picker: any, monthYearDuration: Partial<LocalMonthYearDuration>): void

      • Parameter

        • picker: any

          Ein Verweis auf den Terminwähler, für den der Monat und das Jahr des Kalenders festgelegt werden sollen.

        • monthYearDuration: Partial<LocalMonthYearDuration>

          Der Monat und das Jahr, die ausgewählt werden sollen, relativ zum aktuell ausgewählten Monat und Jahr. Wenn nicht angegeben, wird der Monat und das Jahr auf 0 gesetzt. Kann negativ sein.

        Rückgabewert void

    selectDate: (
        picker: any,
        date: LocalDate,
        options?: AppointmentPickerSetDateOptions,
    ) => void

    Wählt einen bestimmten Tag aus und zeigt die verfügbaren Slots dieses Tages an, für alle Terminwähler aus dem angegebenen Verweis.

    Typendeklaration

    selectSlot: (
        picker: any,
        slot: AppointmentSlot,
        options?: AppointmentPickerSetSlotOptions,
    ) => void

    Ändert den aktuell ausgewählten Slot in den angegebenen Slot oder löscht den ausgewählten Slot, für alle Terminwähler aus dem angegebenen Verweis.

    Typendeklaration

    setPersistedAppointment: (
        picker: any,
        appointment: AppointmentPickerPersistedAppointment,
    ) => void

    Setzt den persistierten Termin für alle Terminwähler aus dem angegebenen Verweis.

    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.

    Typendeklaration

    Einstellungen

    Member-Sichtbarkeit

    Auf dieser Seite

    Eigenschaften