update_os_event()

Aktualisiert den Script-Code — und optional die Skriptsprache — eines bestehenden OsEvents über dms.UpdateOsEvent.

Änderbar sind der Script-Code (vb_code) und — über is_js — die Skriptsprache. Event-Code, Ziel-Objekttyp, Kontextparameter und Plattform sind unveränderlich. Um eine dieser Eigenschaften zu ändern, lösche das Event mit delete_os_event() und lege es mit create_os_event() neu an — dabei entsteht eine neue id.

1. Signatur

  • Sync

  • Async

ecm.system.update_os_event(
    os_event_id: int,
    script: str,
    *,
    is_js: bool | None = None,
) -> None
await ecm.system.update_os_event(
    os_event_id: int,
    script: str,
    *,
    is_js: bool | None = None,
) -> None

2. Parameter

Parameter Typ Standard Beschreibung

os_event_id

int

—

id des zu aktualisierenden Events (das id-Feld eines ECMOsEvent).

script

str

—

Neuer Script-Code (JavaScript oder VBScript). Wird als UTF-8 mit vorangestelltem Byte Order Mark (BOM) an den Server gesendet; der Server erkennt das BOM und speichert den vollen Unicode-Umfang.

is_js

bool | None

None

Wechselt die Skriptsprache: True = JavaScript, False = VBScript. Ohne Angabe behält das Event seine bisherige Sprache — dadurch bleiben bestehende Aufrufe unverändert.

3. Rückgabewert

Keiner (None). Bei einem Serverfehler wird eine Exception ausgelöst.

4. Beispiele

  • Sync

  • Async

ecm.system.update_os_event(9, "'aktualisiertes Skript")

# Event auf JavaScript umstellen
ecm.system.update_os_event(9, "// aktualisiertes Skript", is_js=True)
await ecm.system.update_os_event(9, "'aktualisiertes Skript")

# Event auf JavaScript umstellen
await ecm.system.update_os_event(9, "// aktualisiertes Skript", is_js=True)

5. Siehe auch