PollerOptions interface
Optionen für Vorgänge mit langer Ausführungsdauer (Poller) im Formularerkennung Clients.
- Extends
Eigenschaften
on |
Ein optionaler anfänglicher Fortschrittshandler, der aufgerufen wird, wenn der Pollerstatus aktualisiert wird. Dieser Handler wird sofort aufgerufen, nachdem der Abfragezustand initialisiert wurde. |
resume |
Ein serialisierter Abfragezustand. Falls angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt gestartet zu werden, als ob es sich um einen neuen Vorgang handelt. |
update |
Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang. |
Geerbte Eigenschaften
abort |
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann. |
on |
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden. |
request |
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden. |
serializer |
Optionen zum Überschreiben des Serialisierungs-/De serialisierungsverhaltens. |
tracing |
Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist. |
Details zur Eigenschaft
onProgress
Ein optionaler anfänglicher Fortschrittshandler, der aufgerufen wird, wenn der Pollerstatus aktualisiert wird. Dieser Handler wird sofort aufgerufen, nachdem der Abfragezustand initialisiert wurde.
onProgress?: (state: TState) => void
Eigenschaftswert
(state: TState) => void
resumeFrom
Ein serialisierter Abfragezustand. Falls angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt gestartet zu werden, als ob es sich um einen neuen Vorgang handelt.
resumeFrom?: string
Eigenschaftswert
string
updateIntervalInMs
Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang.
updateIntervalInMs?: number
Eigenschaftswert
number
Geerbte Eigenschaftsdetails
abortSignal
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
abortSignal?: AbortSignalLike
Eigenschaftswert
Geerbt von OperationOptions.abortSignal
onResponse
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden.
onResponse?: RawResponseCallback
Eigenschaftswert
Geerbt von OperationOptions.onResponse
requestOptions
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
requestOptions?: OperationRequestOptions
Eigenschaftswert
Geerbt von OperationOptions.requestOptions
serializerOptions
Optionen zum Überschreiben des Serialisierungs-/De serialisierungsverhaltens.
serializerOptions?: SerializerOptions
Eigenschaftswert
Geerbt von OperationOptions.serializerOptions
tracingOptions
Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.
tracingOptions?: OperationTracingOptions
Eigenschaftswert
Geerbt von OperationOptions.tracingOptions