PollerOptions interface
Alternativ för långvariga åtgärder (pollers) i formigenkänningsklienter.
- Extends
Egenskaper
on |
En valfri inledande förloppshanterare som anropas när pollertillståndet uppdateras. Den här hanteraren anropas en gång omedelbart efter att pollertillståndet har initierats. |
resume |
Ett serialiserat pollertillstånd. Om det tillhandahålls återupptas avsökningsåtgärden från det angivna tillståndet i stället för att startas som om det vore en ny åtgärd. |
update |
Hur lång tid det går att vänta (i millisekunder) mellan efterföljande begäranden som rör samma åtgärd. |
Ärvda egenskaper
abort |
Den signal som kan användas för att avbryta begäranden. |
on |
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger. |
request |
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden. |
serializer |
Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende. |
tracing |
Alternativ som används när spårning är aktiverat. |
Egenskapsinformation
onProgress
En valfri inledande förloppshanterare som anropas när pollertillståndet uppdateras. Den här hanteraren anropas en gång omedelbart efter att pollertillståndet har initierats.
onProgress?: (state: TState) => void
Egenskapsvärde
(state: TState) => void
resumeFrom
Ett serialiserat pollertillstånd. Om det tillhandahålls återupptas avsökningsåtgärden från det angivna tillståndet i stället för att startas som om det vore en ny åtgärd.
resumeFrom?: string
Egenskapsvärde
string
updateIntervalInMs
Hur lång tid det går att vänta (i millisekunder) mellan efterföljande begäranden som rör samma åtgärd.
updateIntervalInMs?: number
Egenskapsvärde
number
Information om ärvda egenskaper
abortSignal
Den signal som kan användas för att avbryta begäranden.
abortSignal?: AbortSignalLike
Egenskapsvärde
ärvd från OperationOptions.abortSignal
onResponse
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
onResponse?: RawResponseCallback
Egenskapsvärde
ärvd från OperationOptions.onResponse
requestOptions
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
requestOptions?: OperationRequestOptions
Egenskapsvärde
ärvd från OperationOptions.requestOptions
serializerOptions
Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.
serializerOptions?: SerializerOptions
Egenskapsvärde
ärvd från OperationOptions.serializerOptions
tracingOptions
Alternativ som används när spårning är aktiverat.
tracingOptions?: OperationTracingOptions
Egenskapsvärde
ärvd från OperationOptions.tracingOptions