CustomFunctions.CancelableInvocation interface

Paket:
custom-functions-runtime

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

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

Wenn die Metadaten-JSON-Datei aus JSDoc-Kommentaren generiert wird, schließen Sie das Tag @cancelableein.

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