عميل GrabzIt مع بيثون

الوصف

يعالج هذا الفصل كل الاتصالات مع خدمات الويب GrabzIt screenshot.

الطرق العامة

• GetResult(id)
• URLToAnimation(url, options = None)
• URLToImage(url, options = None)
• HTMLToImage(html, options = None)
• FileToImage(path, options = None)
• URLToPDF(url, options = None)
• HTMLToPDF(html, options = None)
• FileToPDF(path, options = None)
• URLToDOCX(url, options = None)
• HTMLToDOCX(html, options = None)
• FileToDOCX(path, options = None)
• URLToTable(url, options = None)
• HTMLToTable(html, options = None)
• FileToTable(path, options = None)
• URLToRenderedHTML(url, options = None)
• HTMLToRenderedHTML(html, options = None)
• FileToRenderedHTML(path, options = None)
• Save(callBackURL = '')
• SaveTo()
• SaveTo(saveToFile)
• GetStatus(id)
• GetCookies(domain)
• SetCookie(name, domain, value = "", path = "/", httponly = False, expires = "")
• DeleteCookie(name, domain)
• GetWaterMarks()
• GetWaterMark(identifier)
• AddWaterMark(identifier, path, xpos, ypos)
• DeleteWaterMark(identifier)
• SetLocalProxy(proxyUrl)
• UseSSL(value)
• CreateEncryptionKey()
• Decrypt(path, key)
• DecryptFile(path, key)

GetResult(هوية شخصية)

هذه الطريقة تقوم بإرجاع لقطة الشاشة نفسها. إذا لم يتم إرجاع أي شيء ، فقد حدث خطأ ما أو أن لقطة الشاشة ليست جاهزة بعد.

المعلمات

• معرف - المعرف الفريد للشاشة
  • مطلوب:

قيمة الإرجاع

القبض

URLToAnimation(موقع المعلومات العالمي، الخيارات = لا شيء)

حدد عنوان URL للفيديو عبر الإنترنت الذي يجب تحويله intيا المتحركة GIF.

المعلمات

• عنوان url - عنوان URL لتحويل الفيديو عبر الإنترنت intس المتحركة GIF.
  • مطلوب:
  • يقبل عنوان URL لفيديو Vimeo و YouTube
    • يعتمد تحذير تنشيط مقاطع فيديو Vimeo و YouTube على جهة خارجية وبالتالي قد لا يوفر نتائج متسقة.
• الخيارات - مثيل ل GrabzItAnimationOptions فئة تحدد أي خيارات خاصة لاستخدامها عند إنشاء صورة GIF متحركة.

قيمة الإرجاع

باطل

GrabzItAnimationOptions

يمثل الفصل جميع الخيارات المتاحة عند إنشاء صورة GIF متحركة.

سمات

• customId - معرف مخصص يمكنك تمريره إلى خدمة الويب GIF المتحركة. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
  • الافتراضي: فارغ
• width - عرض GIF المتحركة الناتجة بالبكسل.
  • الافتراضي: 180px
  • الحد الأقصى: أقصى عرض للحزمة
  • الحجم التلقائي: -1 (تمرير -1 يعني أن عرض يتم تحجيم GIF المتحركة فيما يتعلق بارتفاعه ، إذا كان حجم العرض تلقائيًا ، فلن يتمكن الارتفاع من ذلك)
• height - ارتفاع GIF المتحركة الناتجة بالبكسل.
  • الافتراضي: 120px
  • الحد الأقصى: أقصى ارتفاع للحزمة
  • الحجم التلقائي: -1 (تمرير -1 يعني أن ارتفاع يتم تحجيم GIF المتحركة فيما يتعلق بعرضه ، إذا كان الارتفاع يتم تلقائيًا ، فلا يمكن للعرض)
• start - موضع بدء الفيديو الذي يجب تحويله intيا المتحركة GIF.
  • الافتراضي: 0 ثانية
• duration - طول ثواني الفيديو التي يجب تحويلها intيا المتحركة GIF.
  • الافتراضي: الحد الأقصى لطول الحزمة
• speed - سرعة GIF المتحركة.
  • الافتراضي: 1
  • الحد الأدنى: 0.2
  • الحد الأقصى: 10
• framesPerSecond - عدد الإطارات في الثانية التي يجب التقاطها من الفيديو.
  • الافتراضي: 10
  • الحد الأدنى: 0.2
  • الحد الأقصى: 60
• repeat - عدد مرات تكرار حلقة GIF المتحركة.
  • الافتراضي: 0
  • حلقة مستمرة: 0
• reverse - إذا كان هذا صحيحًا ، يتم عكس إطارات GIF المتحركة
  • الافتراضي: خطأ
• customWaterMarkId - اضافة العرف watermark إلى GIF المتحركة
  • الافتراضي: فارغ
• quality - ال جودة الصورة التي تم إرجاعهاالذي يحتوي على ضغط افتراضي قدره 85٪.
  • إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
  • الافتراضي: -1
  • الحد الأدنى: -1
  • الحد الأقصى: 100
• country - البلد GIF المتحركة يجب أن تؤخذ من.
  • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
  • الافتراضي: الموقع الحالي الأسرع
  • الخيارات: "SG" ، "UK" ، "US"
• exportURL - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
  • الافتراضي: فارغ
• encryptionKey - إذا تم تحديد مفتاح التشفير AES المشفر 64 الأساسي ، يتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
  • الافتراضي: فارغ
• proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
  • الافتراضي: فارغ

URLToImage(موقع المعلومات العالمي، الخيارات = لا شيء)

يحدد عنوان URL الذي يجب تحويله intيا صورة لقطة للشاشة.

المعلمات

• عنوان url - عنوان URL الذي يجب أن تكون لقطة الشاشة منه
  • مطلوب:
• الخيارات - مثيل ل GrabzItImageOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء لقطة الشاشة.

قيمة الإرجاع

باطل

HTMLToImage(أتش تي أم أل، الخيارات = لا شيء)

يحدد HTML الذي يجب تحويله intيا صورة.

المعلمات

• أتش تي أم أل - HTML لتحويل intيا صورة
  • مطلوب:
• الخيارات - مثيل ل GrabzItImageOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء صورة.

قيمة الإرجاع

باطل

FileToImage(مسار، الخيارات = لا شيء)

يحدد ملف HTML الذي يجب تحويله intيا صورة.

المعلمات

• المسار - مسار ملف ملف HTML لتحويله intيا صورة
  • مطلوب:
• الخيارات - مثيل ل GrabzItImageOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء صورة.

قيمة الإرجاع

باطل

GrabzItImageOptions

يمثل الفصل جميع الخيارات المتاحة عند إنشاء التقاطات للصورة.

سمات

• customId - معرف مخصص يمكنك نقله إلى لقطة شاشة webservice. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
  • الافتراضي: فارغ
• browserWidth - عرض المتصفح بالبكسل
  • الافتراضي: 1024
  • الحد الأقصى: 10000
• browserHeight - ارتفاع المتصفح بالبكسل
  • الافتراضي: 768
  • الحد الأقصى: 10000
  • الطول الكامل: -1 (تمرير -1 يعني أنه تم التقاط صورة نصية لصفحة الويب بالكامل)
• width - عرض الصورة المصغرة الناتجة بالبكسل
  • الإفتراضي: أعلى نسبة من عرض المتصفح ممكن أن تتناسب مع الحد الأقصى للعرض لحزمة المستخدمين
  • الحد الأقصى: أقصى عرض للحزمة
  • العرض الكامل: -1 (تمرير -1 يعني أنه لا يتم تقليل عرض الصورة المصغرة)
• height - ارتفاع الصورة المصغرة الناتجة بالبكسل
  • الإفتراضي: أعلى نسبة لارتفاع المتصفح ممكن أن تتناسب مع أقصى ارتفاع لحزمة المستخدمين
  • الحد الأقصى: أقصى ارتفاع للحزمة
  • الطول الكامل: -1 (تمرير -1 يعني أنه لا يتم تقليل ارتفاع الصورة المصغرة)
• format - الشكل الذي يجب أن تكون عليه لقطة الشاشة.
  • الافتراضي: "jpg"
  • الخيارات: "bmp8" ، "bmp16" ، "bmp24" ، "bmp" ، "tiff" ، "webp" ، "jpg" ، "png"
• delay - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
  • الافتراضي: 0
  • الحد الأقصى: 30000
• targetElement - ال محدد CSS من عنصر HTML الوحيد على صفحة الويب المستهدفة المراد تشغيلها intoa لقطة شاشة ، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
  • الافتراضي: فارغ
• hideElement - ال محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
  • الافتراضي: فارغ
• waitForElement - ال محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
  • الافتراضي: فارغ
• requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
  • الافتراضي: 0
  • خيارات:
    • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
    • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
    • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
• customWaterMarkId - إضافة العرف watermark على الصورة
  • الافتراضي: فارغ
• quality - ال جودة الصورة التي تم إرجاعها. لا يؤثر هذا حاليًا إلا على صور JPG و WEBP ، والتي لها ضغط افتراضي بنسبة 90٪.
  • إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
  • الافتراضي: -1
  • الحد الأدنى: -1
  • الحد الأقصى: 100
• transparent - إذا كان صحيحا يجب أن يكون التقاط الصور شفافًا. هذا متوافق فقط مع صور بابوا نيو غينيا وتيف.
  • الافتراضي: خطأ
• hd - إذا كانت الصورة حقيقية سوف يكون التقاط في عالية الوضوح هذا يضاعف حجم أبعاد الصورة.
  • الافتراضي: خطأ
• country - البلد لقطة ينبغي أن تؤخذ من.
  • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
  • الافتراضي: الموقع الحالي الأسرع
  • الخيارات: "SG" ، "UK" ، "US"
• exportURL - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
  • الافتراضي: فارغ
• encryptionKey - إذا تم تحديد مفتاح التشفير AES المشفر 64 الأساسي ، يتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
  • الافتراضي: فارغ
• noAds - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
  • الافتراضي: خطأ
• noCookieNotifications - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
  • الافتراضي: خطأ
• address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
  • الافتراضي: فارغ
• proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
  • الافتراضي: فارغ

طرق

• AddPostParameter (الاسم ، القيمة) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
  • الاسم - اسم المعلمة HTTP Post
  • القيمة - قيمة المعلمة HTTP Post

URLToRenderedHTML(موقع المعلومات العالمي، الخيارات = لا شيء)

يحدد عنوان URL الذي يجب تحويله intس المقدمة HTML.

المعلمات

• عنوان url - عنوان URL الذي يجب أن يتكون منه HTML
  • مطلوب:
• الخيارات - مثيل ل GrabzItHTMLOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدم.

قيمة الإرجاع

باطل

HTMLToRenderedHTML(أتش تي أم أل، الخيارات = لا شيء)

يحدد HTML الذي يجب تحويله intس المقدمة HTML.

المعلمات

• أتش تي أم أل - HTML لتحويل intس المقدمة HTML
  • مطلوب:
• الخيارات - مثيل ل GrabzItHTMLOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدمة.

قيمة الإرجاع

باطل

FileToRenderedHTML(مسار، الخيارات = لا شيء)

يحدد ملف HTML الذي يجب تحويله intس المقدمة HTML.

المعلمات

• المسار - مسار ملف ملف HTML لتحويله intس المقدمة HTML
  • مطلوب:
• الخيارات - مثيل ل GrabzItHTMLOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدمة.

قيمة الإرجاع

باطل

GrabzItHTMLOptions

يمثل الفصل جميع الخيارات المتاحة عند خلق يلتقط HTML المقدمة.

سمات

• customId - معرف مخصص يمكنك تمريره إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
  • الافتراضي: فارغ
• browserWidth - عرض المتصفح بالبكسل
  • الافتراضي: 1024
  • الحد الأقصى: 10000
• browserHeight - ارتفاع المتصفح بالبكسل
  • الافتراضي: 768
  • الحد الأقصى: 10000
• waitForElement - ال محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
  • الافتراضي: فارغ
• requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
  • الافتراضي: 0
  • خيارات:
    • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
    • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
    • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
• country - البلد لقطة ينبغي أن تؤخذ من.
  • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
  • الافتراضي: الموقع الحالي الأسرع
  • الخيارات: "SG" ، "UK" ، "US"
• exportURL - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
  • الافتراضي: فارغ
• encryptionKey - إذا تم تحديد مفتاح التشفير AES المشفر 64 الأساسي ، يتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
  • الافتراضي: فارغ
• noAds - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
  • الافتراضي: خطأ
• noCookieNotifications - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
  • الافتراضي: خطأ
• address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
  • الافتراضي: فارغ
• proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
  • الافتراضي: فارغ

طرق

• AddPostParameter (الاسم ، القيمة) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
  • الاسم - اسم المعلمة HTTP Post
  • القيمة - قيمة المعلمة HTTP Post

URLToPDF(موقع المعلومات العالمي، الخيارات = لا شيء)

يحدد عنوان URL الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

• عنوان url - عنوان URL الذي يجب تحويله intيا قوات الدفاع الشعبي
  • مطلوب:
• الخيارات - مثيل لفئة GrabzItPDFOptions التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

HTMLToPDF(أتش تي أم أل، الخيارات = لا شيء)

يحدد HTML الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

• أتش تي أم أل - HTML لتحويل intيا قوات الدفاع الشعبي
  • مطلوب:
• الخيارات - مثيل لفئة GrabzItPDFOptions التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

FileToPDF(مسار، الخيارات = لا شيء)

يحدد ملف HTML الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

• المسار - مسار ملف ملف HTML لتحويله intيا قوات الدفاع الشعبي
  • مطلوب:
• الخيارات - مثيل لفئة GrabzItPDFOptions التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

GrabzItPDFOptions

يمثل الفصل جميع الخيارات المتاحة عند إنشاء ملفات PDF.

سمات

• customId - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
  • الافتراضي: فارغ
• includeBackground - إذا كان هذا صحيحًا ، يجب تضمين خلفية صفحة الويب في لقطة الشاشة
  • الافتراضي: صحيح
• pagesize - حجم صفحة PDF
  • الافتراضي: "A4"
  • الخيارات: "A3" ، "A4" ، "A5" ، "A6" ، "B3" ، "B4" ، "B5" ، "B6" ، "قانوني" ، "خطاب"
• orientation - اتجاه وثيقة PDF
  • الافتراضي: "عمودي"
  • خيارات: "بورتريه" ، "أفقي"
• cssMediaType - ال CSS Media نوع مستند PDF
  • الشاشة الافتراضية"
  • خيارات: "الشاشة" ، "العلاقات العامةint"
• includeLinks - صحيح إذا كانت الروابط يجب أن تدرج في PDF
  • الافتراضي: صحيح
• includeOutline - صحيح إذا قوات الدفاع الشعبي الإشارات المرجعية ينبغي أن تدرج
  • الافتراضي: خطأ
• title - تقديم عنوان لمستند PDF
  • الافتراضي: فارغ
• coverURL - عنوان URL لصفحة الويب التي يجب استخدامها كصفحة غلاف لملف PDF
  • الافتراضي: فارغ
• marginTop - الهامش بالمليمترات التي يجب أن تظهر في الجزء العلوي من صفحة وثيقة PDF
  • الافتراضي: 10
• marginLeft - الهامش بالمليمترات التي يجب أن تظهر على يسار صفحة مستند PDF
  • الافتراضي: 10
• marginBottom - الهامش بالمليمترات التي يجب أن تظهر في أسفل صفحة وثيقة PDF
  • الافتراضي: 10
• marginRight - الهامش بالمليمترات التي يجب أن تظهر على يمين مستند PDF
  • الافتراضي: 10
• browserWidth - ال عرض المتصفح بالبكسل
  • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
  • الافتراضي: 1024
  • الحد الأقصى: 10000
  • العرض التلقائي: -1 (تمرير -1 يعني أن عرض المستعرض يطابق عرض مستند PDF)
• pageWidth - ال عرض مخصص لملف PDF الناتج في ملم
  • الافتراضي: مقاس الصفحه عرض
  • الحد الأدنى: 15
• pageHeight - ال ارتفاع مخصص لقوات الدفاع الشعبي الناتجة في ملم
  • الافتراضي: مقاس الصفحه ارتفاع
  • الحد الأدنى: 15
• delay - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
  • الافتراضي: 0
  • الحد الأقصى: 30000
• templateId - أضف قالب المعرف الذي يحدد رأس وتذييل مستند PDF
  • الافتراضي: فارغ
• targetElement - ال محدد CSS من فقط عنصر HTML في صفحة الويب الهدف التي سيتم تشغيلها intيا قوات الدفاع الشعبي، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
  • الافتراضي: فارغ
• hideElement - ال محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
  • الافتراضي: فارغ
• waitForElement - ال محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
  • الافتراضي: فارغ
• requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
  • الافتراضي: 0
  • خيارات:
    • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
    • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
    • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
• customWaterMarkId - إضافة العرف watermark لكل صفحة من صفحات وثيقة PDF
  • الافتراضي: فارغ
• quality - ال جودة PDF عاد. يستخدم الإعداد الافتراضي الجودة الموصى بها لملف PDF.
  • إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
  • الافتراضي: -1
  • الحد الأدنى: -1
  • الحد الأقصى: 100
• country - البلد لقطة ينبغي أن تؤخذ من.
  • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
  • الافتراضي: الموقع الحالي الأسرع
  • الخيارات: "SG" ، "UK" ، "US"
• exportURL - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
  • الافتراضي: فارغ
• encryptionKey - إذا تم تحديد مفتاح التشفير AES المشفر 64 الأساسي ، يتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
  • الافتراضي: فارغ
• noAds - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
  • الافتراضي: خطأ
• noCookieNotifications - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
  • الافتراضي: خطأ
• address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
  • الافتراضي: فارغ
• proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
  • الافتراضي: فارغ
• mergeId - معرف الالتقاط الذي يجب أن يكون دمجها في بداية وثيقة PDF الجديدة
  • الافتراضي: فارغ
• password - ال كلمة مرور لحماية وثيقة PDF مع
  • الافتراضي: فارغ

طرق

• AddPostParameter (الاسم ، القيمة) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
  • الاسم - اسم المعلمة HTTP Post
  • القيمة - قيمة المعلمة HTTP Post
• AddTemplateParameter (الاسم ، القيمة) - تحديد قالب مخصص المعلمة والقيمة ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة.
  • اسم - اسم المعلمة قالب
  • القيمة - قيمة المعلمة القالب

URLToDOCX (رابط، الخيارات = لا شيء)

يحدد عنوان URL الذي يجب تحويله intيا DOCX.

المعلمات

• عنوان url - عنوان URL الذي يجب تحويله intيا DOCX
  • مطلوب:
• الخيارات - مثيل ل GrabzItDOCXOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء DOCX.

قيمة الإرجاع

باطل

HTMLToDOCX(أتش تي أم أل، الخيارات = لا شيء)

يحدد HTML الذي يجب تحويله intيا DOCX.

المعلمات

• أتش تي أم أل - HTML لتحويل intيا DOCX
  • مطلوب:
• الخيارات - مثيل ل GrabzItDOCXOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء DOCX.

قيمة الإرجاع

باطل

FileToDOCX(مسار، الخيارات = لا شيء)

يحدد ملف HTML الذي يجب تحويله intيا DOCX.

المعلمات

• المسار - مسار ملف ملف HTML لتحويله intيا DOCX
  • مطلوب:
• الخيارات - مثيل ل GrabzItDOCXOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند إنشاء DOCX.

قيمة الإرجاع

باطل

GrabzItDOCXOptions

يمثل الفصل جميع الخيارات المتاحة عند إنشاء التقاط DOCX.

سمات

• customId - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
  • الافتراضي: فارغ
• includeBackground - إذا كان هذا صحيحًا ، يجب تضمين الصور الخلفية لصفحة الويب في DOCX
  • الافتراضي: صحيح
• pagesize - حجم صفحة DOCX
  • الافتراضي: "A4"
  • الخيارات: "A3" ، "A4" ، "A5" ، "A6" ، "B3" ، "B4" ، "B5" ، "B6" ، "قانوني" ، "خطاب"
• orientation - اتجاه وثيقة DOCX
  • الافتراضي: "عمودي"
  • خيارات: "بورتريه" ، "أفقي"
• includeLinks - صحيح إذا كانت الروابط يجب أن تدرج في DOCX
  • الافتراضي: صحيح
• includeImages - إذا كان هذا صحيحًا ، يجب تضمين الصور الخلفية لصفحة الويب في DOCX
  • الافتراضي: صحيح
• title - تقديم عنوان لوثيقة DOCX
  • الافتراضي: فارغ
• marginTop - الهامش بالمليمترات التي يجب أن تظهر في أعلى صفحة مستند DOCX
  • الافتراضي: 10
• marginLeft - الهامش بالمليمترات التي يجب أن تظهر على يسار صفحة مستند DOCX
  • الافتراضي: 10
• marginBottom - الهامش بالمليمترات التي يجب أن تظهر في أسفل صفحة مستند DOCX
  • الافتراضي: 10
• marginRight - الهامش بالمليمترات التي يجب أن تظهر على يمين مستند DOCX
  • الافتراضي: 10
• browserWidth - ال عرض المتصفح بالبكسل
  • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
  • الافتراضي: 1024
  • الحد الأقصى: 10000
  • العرض التلقائي: -1 (تمرير -1 يعني أن عرض المستعرض يطابق عرض مستند DOCX)
• pageWidth - ال عرض مخصص لل DOCX الناتجة في ملم
  • الافتراضي: مقاس الصفحه عرض
  • الحد الأدنى: 15
• pageHeight - ال ارتفاع مخصص لل DOCX الناتجة في ملم
  • الافتراضي: مقاس الصفحه ارتفاع
  • الحد الأدنى: 15
• delay - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
  • الافتراضي: 0
  • الحد الأقصى: 30000
• templateId - أضف قالب المعرف الذي يحدد رأس وتذييل مستند DOCX
  • الافتراضي: فارغ
• targetElement - ال محدد CSS من عنصر HTML الوحيد على صفحة الويب المستهدفة المراد تشغيلها intيا DOCX ، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
  • الافتراضي: فارغ
• hideElement - ال محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
  • الافتراضي: فارغ
• waitForElement - ال محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
  • الافتراضي: فارغ
• requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
  • الافتراضي: 0
  • خيارات:
    • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
    • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
    • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
• quality - ال جودة DOCX عاد. الافتراضي يستخدم الجودة الموصى بها ل DOCX.
  • إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
  • الافتراضي: -1
  • الحد الأدنى: -1
  • الحد الأقصى: 100
• country - البلد لقطة ينبغي أن تؤخذ من.
  • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
  • الافتراضي: الموقع الحالي الأسرع
  • الخيارات: "SG" ، "UK" ، "US"
• exportURL - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
  • الافتراضي: فارغ
• encryptionKey - إذا تم تحديد مفتاح التشفير AES المشفر 64 الأساسي ، يتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
  • الافتراضي: فارغ
• noAds - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
  • الافتراضي: خطأ
• noCookieNotifications - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
  • الافتراضي: خطأ
• address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
  • الافتراضي: فارغ
• proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
  • الافتراضي: فارغ
• mergeId - معرف الالتقاط الذي يجب أن يكون دمجها في بداية وثيقة DOCX الجديدة
  • الافتراضي: فارغ
• password - ال كلمة المرور لحماية وثيقة DOCX مع
  • الافتراضي: فارغ

طرق

• AddPostParameter (الاسم ، القيمة) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
  • الاسم - اسم المعلمة HTTP Post
  • القيمة - قيمة المعلمة HTTP Post
• AddTemplateParameter (الاسم ، القيمة) - تحديد قالب مخصص المعلمة والقيمة ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة.
  • اسم - اسم المعلمة قالب
  • القيمة - قيمة المعلمة القالب

URLToTable(موقع المعلومات العالمي، الخيارات = لا شيء)

يحدد عنوان URL الذي يجب استخراج جداول HTML منه.

المعلمات

• عنوان url - عنوان URL لاستخراج جداول HTML من
  • مطلوب:
• الخيارات - مثيل ل GrabzItTableOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند تحويل جدول HTML.

قيمة الإرجاع

باطل

HTMLToTable (أتش تي أم أل، الخيارات = لا شيء)

يحدد HTML الذي يجب استخراج جداول HTML منه.

المعلمات

• أتش تي أم أل - HTML لاستخراج جداول HTML من.
  • مطلوب:
• الخيارات - مثيل ل GrabzItTableOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند تحويل جدول HTML.

قيمة الإرجاع

باطل

FileToTable (المسار، الخيارات = لا شيء)

يحدد ملف HTML الذي يجب استخراج جداول HTML منه.

المعلمات

• المسار - مسار ملف ملف HTML لاستخراج جداول HTML من.
  • مطلوب:
• الخيارات - مثيل ل GrabzItTableOptions الفئة التي تحدد أي خيارات خاصة لاستخدامها عند تحويل جدول HTML.

قيمة الإرجاع

باطل

GrabzItTableOptions

يمثل الفصل جميع الخيارات المتاحة عند تحويل جداول HTML إلى CSV أو XLSX أو JSON.

سمات

• customId - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته
  • الافتراضي: فارغ
• tableNumberToInclude - فهرس الجدول المطلوب تحويله ، إذا كانت جميع الجداول في صفحة الويب مرتبة من أعلى صفحة الويب إلى أسفل
  • الافتراضي: 1
• format - يجب أن يكون الجدول في
  • الافتراضي: "CSV"
  • خيارات: "CSV" ، "json" ، "xlsx"
• includeHeaderNames - إذا تم إدراج أسماء الرؤوس الحقيقية في الجدول
  • الافتراضي: صحيح
• includeAllTables - إذا كان هذا صحيحًا ، فسيتم استخراج كل جدول في صفحة الويب مع ظهور كل جدول في ورقة بيانات منفصلة. متوفر فقط بتنسيق XLSX
  • الافتراضي: خطأ
• targetElement - معرف عنصر HTML الوحيد في صفحة الويب التي يجب استخدامها لاستخراج الجداول من
  • الافتراضي: فارغ
• requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
  • الافتراضي: 0
  • خيارات:
    • 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
    • 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
    • 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
• country - البلد لقطة ينبغي أن تؤخذ من.
  • تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
  • الافتراضي: الموقع الحالي الأسرع
  • الخيارات: "SG" ، "UK" ، "US"
• exportURL - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
  • الافتراضي: فارغ
• encryptionKey - إذا تم تحديد مفتاح التشفير AES المشفر 64 الأساسي ، يتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
  • الافتراضي: فارغ
• address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
  • الافتراضي: فارغ
• proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
  • الافتراضي: فارغ

طرق

• AddPostParameter (الاسم ، القيمة) - يحدد معلمة HTTP Post والقيمة الاختيارية ، يمكن استدعاء هذه الطريقة عدة مرات لإضافة معلمات متعددة. باستخدام هذه الطريقة سوف يجبر GrabzIt ل أداء وظيفة HTTP.
  • الاسم - اسم المعلمة HTTP Post
  • القيمة - قيمة المعلمة HTTP Post

Save(callBackURL = '')

Save النتيجة بشكل غير متزامن وإرجاع معرف فريد ، والتي يمكن استخدامها للحصول على لقطة مع GetResult الأسلوب.

المعلمات

• callBackURL - معالج يجب على خدمة GrabzIt الاتصال بعد اكتمال عملها

قيمة الإرجاع

يتم طرح المعرف الفريد للشاشة وإلا إذا حدث خطأ. ويمكن استخدام هذا للحصول على لقطة مع GetResult طريقة

SaveTo()

Save النتيجة بشكل متزامن لمتغير يحتوي على بيانات بايت الشاشة.

قيمة الإرجاع

إرجاع بيانات البايت للملف في حالة نجاحه ، وإلا فإنه يلقي استثناء.

SaveTo(saveToملف)

Save النتيجة بشكل متزامن إلى ملف.

المعلمات

• saveToملف - مسار الملف الذي سيتم التقاطه saveد إلى بمجرد الانتهاء منه
  • مطلوب:

قيمة الإرجاع

تقوم بإرجاع القيمة الحقيقية إذا كانت ناجحة وإلا فإنها ستلقي استثناءً.

GetStatus (معرف)

الحصول على الوضع الحالي للشاشة GrabzIt.

المعلمات

• معرف - المعرف الفريد للشاشة
  • مطلوب:

قيمة الإرجاع

ScreenShotStatus موضوع

GetCookies (المجال)

احصل على جميع ملفات تعريف الارتباط التي يستخدمها GrabzIt لمجال معين. قد يشمل ذلك ملفات تعريف الارتباط المعرفة من قبل المستخدم.

المعلمات

• المجال - المجال لإرجاع ملفات تعريف الارتباط لـ
  • مطلوب:

قيمة الإرجاع

GrabzItCookie مجموعة

SetCookie (الاسم ، المجال ، القيمة = "" ، المسار = "/" ، httponly = خطأ ، تنتهي = "")

يعين ملف تعريف ارتباط مخصص جديد على GrabzIt ، إذا كان ملف تعريف الارتباط المخصص يحمل نفس الاسم والمجال مثل ملف تعريف الارتباط العام ، يتم تجاوز ملف تعريف الارتباط العام.

قد يكون ذلك مفيدًا إذا كانت ملفات مواقع الويب تتحكم فيها ملفات تعريف الارتباط.

المعلمات

• اسم - اسم ملف تعريف الارتباط لتعيين
  • مطلوب:
• المجال - مجال موقع الويب لتعيين ملف تعريف الارتباط لـ
  • مطلوب:
• القيمة - قيمة ملف تعريف الارتباط
• المسار - مسار موقع الويب الذي يرتبط به ملف تعريف الارتباط
• httponly - إذا كان هذا صحيحًا ، فيمكن استخدام ملف تعريف الارتباط فقط مع بروتوكول HTTP
• تنتهي صلاحيته - يحدد وقت انتهاء صلاحية ملف تعريف الارتباط. تمرير قيمة بلا إذا كان ملف تعريف الارتباط يجب أن لا تنتهي
  • يجب أن تكون بالتنسيق yyyy-mm-dd hh: mm: ss

قيمة الإرجاع

صحيح إذا تم تعيين ملف تعريف الارتباط بنجاح ، وإلا خطأ

DeleteCookie (الاسم ، المجال)

حذف ملف تعريف ارتباط مخصص أو حظر ملف تعريف ارتباط عمومي من الاستخدام

المعلمات

• اسم - اسم ملف تعريف الارتباط المراد حذفه
  • مطلوب:
• المجال - مجال موقع الويب لحذف ملف تعريف الارتباط لـ
  • مطلوب:

قيمة الإرجاع

صحيح إذا تم حذف ملف تعريف الارتباط بنجاح ، وإلا كان خطأ

الحصول علىWaterMarks()

احصل على مخصصك الذي تم تحميله watermarks

قيمة الإرجاع

GrabzItWaterMark مجموعة

الحصول علىWaterMark(المعرف)

عودة العرف الخاص بك watermarks الذي يطابق المعرف المحدد

المعلمات

• المعرف - معرف مخصص معين watermark تريد المشاهدة
  • مطلوب:

قيمة الإرجاع

GrabzItWaterMark

أضف جرعات WaterMark(المعرف ، المسار ، xpos ، ypos)

إضافة العرف الجديد watermark

المعلمات

• المعرف - المعرف الذي تريد منحه المخصص watermark. من المهم أن يكون هذا المعرف فريدًا.
  • مطلوب:
• المسار - المسار المطلق لملف watermark على الخادم الخاص بك. على سبيل المثال C: /watermark/1.png
  • مطلوب:
• xpos - الموضع الأفقي الذي تريد أن تظهر فيه لقطة الشاشة
  • مطلوب:
  • خيارات:
    • اليسار = 0
    • مركز = 1
    • اليمين = 2
• ypos - الموضع الرأسي الذي تريد أن تظهر فيه لقطة الشاشة
  • مطلوب:
  • خيارات:
    • أعلى = 0
    • الأوسط = 1
    • أسفل = 2

قيمة الإرجاع

يعود صحيحًا إذا كان watermark تم تعيينه بنجاح

DeleteWaterMark(المعرف)

حذف مخصص watermark

المعلمات

• المعرّف - معرّف العرف watermark تريد حذفه
  • مطلوب:

قيمة الإرجاع

يعود صحيحًا إذا كان watermark تم حذفه بنجاح

SetLocalProxy (proxyUrl)

هذه الطريقة تمكن الخادم الوكيل المحلي ليتم استخدامها لجميع الطلبات.

المعلمات

• proxyUrl - عنوان URL ، الذي يمكن أن يتضمن منفذًا إذا لزم الأمر ، من الوكيل. سيؤدي توفير قيمة خالية إلى إزالة أي وكيل تم تعيينه مسبقًا
  • مطلوب:

UseSSL (القيمة)

يحدد ما إذا كانت طلبات GrabzIt يجب أن تستخدم API SSL

المعلمات

• قيمة - إذا كان هذا صحيحًا ، فستستخدم جميع الطلبات إلى واجهة برمجة تطبيقات GrabzIt SSL
  • مطلوب:

CreateEncryptionKey ()

قم بإنشاء مفتاح تشفير 64 أساسي آمن مشفر بطول أحرف 44.

فك تشفير (البيانات ، مفتاح)

فك تشفير التقاط مشفر باستخدام مفتاح التشفير المقدم.

المعلمات

• البيانات - البايت المشفر
  • مطلوب:
• المفتاح - مفتاح التشفير
  • مطلوب:

DecryptFile (المسار ، مفتاح)

فك تشفير التقاط مشفر باستخدام مفتاح التشفير المقدم.

المعلمات

• المسار - مسار الالتقاط المشفر
  • مطلوب:
• المفتاح - مفتاح التشفير
  • مطلوب:

نتيجة الطبقات

GrabzItCookie

ممتلكات عامة

• Name
  • اسم ملف تعريف الارتباط.
• Value
  • قيمة ملف تعريف الارتباط.
• Domain
  • المجال الذي تم تعيين ملف تعريف الارتباط عليه.
• Path
  • المسار على المجال الذي ينطبق عليه ملف تعريف الارتباط هذا.
• HttpOnly
  • إذا كان ملف تعريف الارتباط هذا صالحًا فقط عند عرض موقع الويب باستخدام بروتوكول HTTP.
• Expires
  • تاريخ انتهاء صلاحية ملف تعريف الارتباط هذا
• Type
  • نوع ملف تعريف الارتباط هذا ، والذي يمكن أن يكون أحد الإجراءات التالية:
    • عالمي - هذا ملف تعريف ارتباط عالمي من إعداد GrabzIt
    • محلي - هذا ملف تعريف ارتباط محلي تم تعيينه بواسطتك
    • تجاوز - ملف تعريف ارتباط عمومي تم تجاوزه بواسطتك

ScreenShotStatus

الطبقة التي تمثل الوضع الحالي للشاشة.

ممتلكات عامة

• Processing
  • إذا كان هذا صحيحًا ، فلا تزال لقطة الشاشة قيد المعالجة.
• Cached
  • إذا كان صحيحًا ، فقد تمت معالجة لقطة الشاشة ويتم تخزينها مؤقتًا في الوقت الحالي.
• Expired
  • إذا كان هذا صحيحًا ، فلم تعد لقطة الشاشة موجودة على نظام GrabzIt.
• Message
  • رسالة خطأ تم إرجاعها بواسطة النظام.

GrabzItWaterMark

هذه الفئة تمثل العادة watermarks مخزنة في GrabzIt

ممتلكات عامة

• Identifier
  • معرّف watermark
• XPosition
  • الوضع الأفقي لـ watermark
    • اليسار = 0
    • مركز = 1
    • اليمين = 2
• YPosition
  • الوضع الرأسي لل watermark
    • أعلى = 0
    • الأوسط = 1
    • أسفل = 2
• Format
  • شكل watermark