BeginComposeDocumentModelOptions interface
Options pour l’opération de composition du modèle.
- Extends
Propriétés héritées
abort |
Signal qui peut être utilisé pour abandonner les demandes. |
description | Description textuelle du modèle (peut être n’importe quel texte). |
on |
Gestionnaire de progression initial facultatif qui sera appelé lors de la mise à jour de l’état de l’polleur. Ce gestionnaire sera appelé une fois immédiatement après l’initialisation de l’état de l’polleur. |
on |
Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois. |
request |
Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération. |
resume |
État sérialisé du polleur. Si elle est fournie, l’opération d’interrogation reprendra à partir de l’état donné au lieu de démarrer comme s’il s’agissait d’une nouvelle opération. |
serializer |
Options permettant de remplacer le comportement de sérialisation/désérialisation. |
tags | Paires clé-valeur supplémentaires spécifiées par l’utilisateur à associer au modèle en tant que métadonnées persistantes. |
tracing |
Options utilisées lorsque le traçage est activé. |
update |
Délai d’attente (en millisecondes) entre les requêtes suivantes relatives à la même opération. |
Détails de la propriété héritée
abortSignal
Signal qui peut être utilisé pour abandonner les demandes.
abortSignal?: AbortSignalLike
Valeur de propriété
description
Description textuelle du modèle (peut être n’importe quel texte).
description?: string
Valeur de propriété
string
onProgress
Gestionnaire de progression initial facultatif qui sera appelé lors de la mise à jour de l’état de l’polleur. Ce gestionnaire sera appelé une fois immédiatement après l’initialisation de l’état de l’polleur.
onProgress?: (state: DocumentModelOperationState) => void
Valeur de propriété
(state: DocumentModelOperationState) => void
onResponse
Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
onResponse?: RawResponseCallback
Valeur de propriété
requestOptions
Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
requestOptions?: OperationRequestOptions
Valeur de propriété
resumeFrom
État sérialisé du polleur. Si elle est fournie, l’opération d’interrogation reprendra à partir de l’état donné au lieu de démarrer comme s’il s’agissait d’une nouvelle opération.
resumeFrom?: string
Valeur de propriété
string
serializerOptions
Options permettant de remplacer le comportement de sérialisation/désérialisation.
serializerOptions?: SerializerOptions
Valeur de propriété
tags
Paires clé-valeur supplémentaires spécifiées par l’utilisateur à associer au modèle en tant que métadonnées persistantes.
tags?: Record<string, string>
Valeur de propriété
Record<string, string>
Hérité deCreateDocumentModelOptions.tags
tracingOptions
Options utilisées lorsque le traçage est activé.
tracingOptions?: OperationTracingOptions
Valeur de propriété
updateIntervalInMs
Délai d’attente (en millisecondes) entre les requêtes suivantes relatives à la même opération.
updateIntervalInMs?: number
Valeur de propriété
number