BeginComposeDocumentModelOptions interface
Alternativ för modellens sammansättningsåtgärd.
- Extends
Ärvda egenskaper
| abort |
Den signal som kan användas för att avbryta begäranden. |
| description | En textbeskrivning av modellen (kan vara valfri text). |
| 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. |
| 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. |
| resume |
Ett serialiserat pollertillstånd. Om den 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. |
| serializer |
Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende. |
| tags | Ytterligare användardefinierade nyckel/värde-par som ska associeras med modellen som beständiga metadata. |
| tracing |
Alternativ som används när spårning är aktiverat. |
| update |
Väntetiden (i millisekunder) mellan efterföljande begäranden som relaterar till samma åtgärd. |
Information om ärvda egenskaper
abortSignal
Den signal som kan användas för att avbryta begäranden.
abortSignal?: AbortSignalLikeEgenskapsvärde
description
En textbeskrivning av modellen (kan vara valfri text).
description?: stringEgenskapsvärde
string
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: DocumentModelOperationState) => voidEgenskapsvärde
(state: DocumentModelOperationState) => void
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?: RawResponseCallbackEgenskapsvärde
requestOptions
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
requestOptions?: OperationRequestOptionsEgenskapsvärde
resumeFrom
Ett serialiserat pollertillstånd. Om den 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?: stringEgenskapsvärde
string
serializerOptions
Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.
serializerOptions?: SerializerOptionsEgenskapsvärde
tags
Ytterligare användardefinierade nyckel/värde-par som ska associeras med modellen som beständiga metadata.
tags?: Record<string, string>Egenskapsvärde
Record<string, string>
Ärvd frånCreateDocumentModelOptions.tags
tracingOptions
Alternativ som används när spårning är aktiverat.
tracingOptions?: OperationTracingOptionsEgenskapsvärde
updateIntervalInMs
Väntetiden (i millisekunder) mellan efterföljande begäranden som relaterar till samma åtgärd.
updateIntervalInMs?: numberEgenskapsvärde
number