CustomFunctions.CancelableInvocation interface

  • Referenz
Paket:
custom-functions-runtime

Stellt Informationen zum Aufruf einer abbrechbaren benutzerdefinierten Funktion bereit. Eine abbrechbare benutzerdefinierte Funktion kann einen Handler für das onCanceled-Ereignis bereitstellen.

Um anzugeben, dass eine Funktion abgebrochen werden kann, sollten in der JSON-Metadatendatei die Funktionsoptionen Folgendes angeben: { "cancelable": true }

Wenn die JSON-Metadatendatei aus JSDoc-Kommentaren generiert wird, fügen Sie das Tag ein @cancelable.

Extends
CustomFunctions.Invocation

Ereignisse

onCanceled

Ereignishandler, der aufgerufen wird, wenn die benutzerdefinierte Funktion abgebrochen wird.

Details zum Ereignis

onCanceled

Ereignishandler, der aufgerufen wird, wenn die benutzerdefinierte Funktion abgebrochen wird.

onCanceled?: () => void;

Ereignistyp

() => void

Hinweise

[ API-Satz: CustomFunctionsRuntime 1.1 ]