BeginComposeDocumentModelOptions interface
خيارات لعملية إنشاء النموذج.
الخصائص الموروثة
| abort |
الإشارة التي يمكن استخدامها لإجهاض الطلبات. |
| description | وصف نصي للنموذج (يمكن أن يكون أي نص). |
| on |
معالج تقدم أولي اختياري سيتم استدعاؤه عند تحديث حالة الاستقصاء. سيتم استدعاء هذا المعالج مرة واحدة مباشرة بعد تهيئة حالة الاستقصاء. |
| on |
دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات. |
| request |
الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية. |
| resume |
حالة الاستقصاء المتسلسل. إذا تم توفيرها، سيتم استئناف عملية الاستقصاء من الحالة المحددة بدلا من البدء كما لو كانت عملية جديدة. |
| serializer |
خيارات لتجاوز سلوك التسلسل/إلغاء التسلسل. |
| tags | أزواج إضافية محددة من قبل المستخدم لربطها بالنموذج كبيانات تعريف ثابتة. |
| tracing |
الخيارات المستخدمة عند تمكين التتبع. |
| update |
مقدار الوقت للانتظار (بالمللي ثانية) بين الطلبات اللاحقة المتعلقة بنفس العملية. |
تفاصيل الخاصية الموروثة
abortSignal
الإشارة التي يمكن استخدامها لإجهاض الطلبات.
abortSignal?: AbortSignalLikeقيمة الخاصية
description
وصف نصي للنموذج (يمكن أن يكون أي نص).
description?: stringقيمة الخاصية
string
onProgress
معالج تقدم أولي اختياري سيتم استدعاؤه عند تحديث حالة الاستقصاء. سيتم استدعاء هذا المعالج مرة واحدة مباشرة بعد تهيئة حالة الاستقصاء.
onProgress?: (state: DocumentModelOperationState) => voidقيمة الخاصية
(state: DocumentModelOperationState) => void
onResponse
دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات.
onResponse?: RawResponseCallbackقيمة الخاصية
requestOptions
الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.
requestOptions?: OperationRequestOptionsقيمة الخاصية
resumeFrom
حالة الاستقصاء المتسلسل. إذا تم توفيرها، سيتم استئناف عملية الاستقصاء من الحالة المحددة بدلا من البدء كما لو كانت عملية جديدة.
resumeFrom?: stringقيمة الخاصية
string
serializerOptions
خيارات لتجاوز سلوك التسلسل/إلغاء التسلسل.
serializerOptions?: SerializerOptionsقيمة الخاصية
tags
أزواج إضافية محددة من قبل المستخدم لربطها بالنموذج كبيانات تعريف ثابتة.
tags?: Record<string, string>قيمة الخاصية
Record<string, string>
الموروثة منCreateDocumentModelOptions.tags
tracingOptions
الخيارات المستخدمة عند تمكين التتبع.
tracingOptions?: OperationTracingOptionsقيمة الخاصية
updateIntervalInMs
مقدار الوقت للانتظار (بالمللي ثانية) بين الطلبات اللاحقة المتعلقة بنفس العملية.
updateIntervalInMs?: numberقيمة الخاصية
number