بروتوكول WebDriver
newSession
يقوم أمر New Session بإنشاء جلسة WebDriver جديدة مع نقطة النهاية. إذا فشل الإنشاء، يتم إرجاع خطأ بأنه لم يتم إنشاء الجلسة.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.newSession(capabilities)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
capabilities | object | كائن JSON، مجموعة القدرات التي تم دمجها ومطابقتها في النهاية في خوارزمية معالجة القدرات |
الإرجاع
- <Object>
session: كائن يحتوي على معرف الجلسة وقدرات جلسة WebDriver التي تم إنشاؤها.
deleteSession
يقوم أمر حذف الجلسة بإغلاق أي سياق تصفح عالي المستوى مرتبط بالجلسة الحالية، وينهي الاتصال، وأخيرًا يغلق الجلسة الحالية.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.deleteSession(deleteSessionOpts)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
deleteSessionOptsاختياري | object | كائن يحتوي على خيارات لأمر deleteSession، مثل { shutdownDriver: boolean } |
status
يقوم أمر الحالة بإرجاع معلومات حول ما إذا كانت نقطة النهاية البعيدة في حالة يمكنها من إنشاء جلسات جديدة ويمكن أيضًا أن تتضمن معلومات تعريفية اعتباطية خاصة بالتن فيذ.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.status()
مثال
loading...
الإرجاع
- <Object>
status: كائن يحتوي على حالة برنامج التشغيل.
getTimeouts
يحصل أمر Get Timeouts على مدد المهلة المرتبطة بالجلسة الحالية.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.getTimeouts()
مثال
loading...
الإرجاع
- <Object>
timeouts: كائن يحتوي على مدد مهلة لمؤقتاتscript، وpageLoad، وimplicit.
setTimeouts
يقوم أمر Set Timeouts بتعيين مدد المهلة المرتبطة بالجلسة الحالية. المؤقتات التي يمكن التحكم بها مدرجة في جدول مهل الجلسة أدناه.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.setTimeouts(implicit, pageLoad, script)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
implicitاختياري | number | عدد صحيح بالميلي ثانية لمهلة الانتظار الضمني للجلسة |
pageLoadاختياري | number | عدد صحيح بالميلي ثانية لمهلة تحميل الصفحة للجلسة |
scriptاختياري | number | عدد صحيح بالميلي ثانية لمهلة النص البرمجي للجلسة |
مثال
loading...
getUrl
يقوم أمر Get Current URL بإرجاع عنوان URL لسياق التصفح الحالي عالي المستوى.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.getUrl()
مثال
loading...
الإرجاع
- <string>
url: عنوان URL لمستند المستند النشط لسياق التصفح الحالي عالي المستوى
navigateTo
يُستخدم أمر navigateTo (go) لجعل وكيل المستخدم ينتقل بسياق التصفح الحالي عالي المستوى إلى موقع جديد.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
هذا الأمر البروتوكولي مدمج في الطريقة المريحة التالية: url. يوصى باستخدام هذا الأمر بدلاً من ذلك.
الاستخدام
browser.navigateTo(url)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
url | string | سلسلة تمثل عنوان URL مطلق (يبدأ بـ http(s))، قد يتضمن جزءًا (#...)، ويمكن أن يكون أيضًا مخططًا محليًا (about: إلخ) |
مثال
loading...
back
يتسبب أمر Back في أن يمر المتصفح خطوة واحدة إلى الوراء في سجل الجلسة المشترك لسياق التصفح الحالي عالي المستوى. وهذا يعادل الضغط على زر الرجوع في واجهة المتصفح أو استدعاء window.history.back.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.back()
مثال
loading...
forward
يتسبب أمر Forward في أن يمر المتصفح خطوة واحدة إلى الأمام في سجل الجلسة المشترك لسياق التصفح الحالي عالي المستوى.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.forward()
مثال
loading...
refresh
يتسبب أمر Refresh في أن يقوم المتصفح بإعادة تحميل الصفحة في سياق التصفح الحالي عالي المستوى.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.refresh()
مثال
loading...
getTitle
يقوم أمر Get Title بإرجاع عنوان المستند لسياق التصفح الحالي عالي المستوى، وهو ما يعادل استدعاء document.title.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.getTitle()
مثال
loading...
الإرجاع
- <string>
title: يرجع سلسلة نصية مماثلة لـdocument.titleلسياق التصفح الحالي عالي المستوى.
getWindowHandle
يقوم أمر Get Window Handle بإرجاع معرف النافذة لسياق التصفح الحالي عالي المستوى. يمكن استخدامه كوسيطة لـ Switch To Window.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.getWindowHandle()
مثال
loading...
الإرجاع
- <string>
handle: يرجع سلسلة نصية وهي معرف النافذة لسياق التصفح الحالي عالي المستوى.
closeWindow
يقوم أمر Close Window بإغلاق سياق التصفح الحالي عالي المستوى. بمجرد الانتهاء، إذا لم تعد هناك سياقات تصفح أخرى عالية المستوى مفتوحة، فإن جلسة WebDriver نفسها تغلق.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.closeWindow()
مثال
loading...
switchToWindow
يُستخدم أمر Switch To Window لتحديد سياق التصفح الحالي عالي المستوى للجلسة الحالية، أي الذي سيتم استخدامه لمعالجة الأوامر.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
هذا الأمر البروتوكولي مدمج في الطريقة المريحة التالية: switchWindow. يوصى باستخدام هذا الأمر بدلاً من ذلك.
الاستخدام
browser.switchToWindow(handle)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
handle | string | سلسلة تمثل معرف نافذة، يجب أن تكون واحدة من السلاسل التي تم إرجاعها في استدعاء getWindowHandles |
مثال
loading...
createWindow
إنشاء سياق تصفح جديد عالي المستوى.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.createWindow(type)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
type | string | تعيين إلى 'tab' إذا كانت النافذة المنشأة حديثًا تشارك نافذة على مستوى نظام التشغيل مع سياق التصفح الحالي، أو 'window' خلاف ذلك. |
مثال
loading...
الإرجاع
- <Object>
window: كائن النافذة الجديد الذي يحتوي على 'handle' بقيمة المعرف و'type' بقيمة نوع النافذة المنشأة
getWindowHandles
يرجع أمر Get Window Handles قائمة بمعرفات النوافذ لكل سياق تصفح عالي المستوى مفتوح. الترتيب الذي يتم فيه إرجاع معرفات النوافذ عشوائي.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.getWindowHandles()
مثال
loading...
الإرجاع
- <String[]>
handles: مصفوفة تحتوي على قائمة معرفات النوافذ.
printPage
يقوم أمر Print Page بتحويل المستند إلى مستند PDF مرقم. ملاحظة: يدعم Chrome حاليًا هذه الميزة فقط في وضع headless، انظر crbug753118).
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.printPage(orientation, scale, background, width, height, top, bottom, left, right, shrinkToFit, pageRanges)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
orientationاختياري | string | اتجاه الصفحة. الافتراضي: portrait |
scaleاختياري | number | مقياس الصفحة. الافتراضي: 1 |
backgroundاختياري | boolean | خلفية الصفحة. الافتراضي: false |
widthاختياري | number | عرض الصفحة بالسنتيمتر. الافتراضي: 21.59 من الصفحة |
heightاختياري | number | ارتفاع الصفحة بالسنتيمتر. الافتراضي: 27.94 من الصفحة |
topاختياري | number | هامش الصفحة بالسنتيمتر من الهامش العلوي. الافتراضي: 1 |
bottomاختياري | number | هامش الصفحة بالسنتيمتر من الهامش السفلي. الافتراضي: 1 |
leftاختياري | number | هامش الصفحة بالسنتيمتر من الهامش الأيسر. الافتراضي: 1 |
rightاختياري | number | هامش الصفحة بالسنتيمتر من الهامش الأيمن. الافتراضي: 1 |
shrinkToFitاختياري | boolean | تصغير ملف PDF ليناسب الصفحة. الافتراضي: true |
pageRangesاختياري | object[] | نطاقات الصفحة. الافتراضي [] |
مثال
loading...
الإرجاع
- <string>
pdf: تمثيل PDF المرمز بـ base64 للمستند المرقم.
switchToFrame
يُستخدم أمر Switch To Frame لتحديد سياق التصفح الحالي عالي المستوى أو سياق تصفح فرعي لسياق التصفح الحالي لاستخدامه كسياق تصفح حالي للأوامر اللاحقة.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
هذا الأمر البروتوكولي مهمل
هذا الأمر مهمل ونشجع الجميع على استخدام switchFrame بدلاً من ذلك للتبديل بين الإطارات. اقرأ المزيد عن هذا الأمر على https://webdriver.io/docs/api/browser/switchFrame.
الاستخدام
browser.switchToFrame(id)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
id | number, object, null | واحد من ثلاثة أنواع محتملة: null: هذا يمثل سياق التصفح عالي المستوى (أي، ليس iframe)، رقم، يمثل فهرس كائن النافذة المقابل للإطار، كائن عنصر تم استلامه باستخدام findElement. |
مثال
loading...
switchToParentFrame
يقوم أمر Switch to Parent Frame بتعيين سياق التصفح الحالي للأوامر المستقبلية إلى الأصل لسياق التصفح الحالي.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.switchToParentFrame()
مثال
loading...
getWindowRect
يرجع أمر Get Window Rect حجم وموضع نافذة نظام التشغيل المقابلة لسياق التصفح الحالي عالي المستوى على الشاشة.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
هذا الأمر البروتوكولي مدمج في الطريقة المريحة التالية: getWindowSize. يوصى باستخدام هذا الأمر بدلاً من ذلك.
الاستخدام
browser.getWindowRect()
مثال
loading...
الإرجاع
- <Object>
windowRect: تمثيل JSON لكائن "مستطيل النافذة". يحتوي هذا على 4 خصائص:x،y،width، وheight.
setWindowRect
يقوم أمر Set Window Rect بتغيير حجم وموضع نافذة نظام التشغيل المقابلة لسياق التصفح الحالي عالي المستوى.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
هذا الأمر البروتوكولي مدمج في الطريقة المريحة التالية: setWindowSize. يوصى باستخدام هذا الأمر بدلاً من ذلك.
الاستخدام
browser.setWindowRect(x, y, width, height)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
x | number, null | خاصية screenX لكائن النافذة |
y | number, null | خاصية screenY لكائن النافذة |
width | number, null | عرض الأبعاد الخارجية لسياق التصفح عالي المستوى، بما في ذلك شريط المتصفح وما إلى ذلك... |
height | number, null | ارتفاع الأبعاد الخارجية لسياق التصفح عالي المستوى، بما في ذلك شريط المتصفح وما إلى ذلك... |
مثال
loading...
الإرجاع
- <Object>
windowRect: تمثيل JSON لكائن "مستطيل النافذة" استنادًا إلى حالة النافذة الجديدة.
maximizeWindow
يستدعي أمر Maximize Window عملية "تكبير" محددة لمدير النوافذ، إن وجدت، على النافذة التي تحتوي على سياق التصفح الحالي عالي المستوى. هذا عادة ما يزيد النافذة إلى الحجم الأقصى المتاح دون الدخول في وضع ملء الشاشة.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.maximizeWindow()
مثال
loading...
الإرجاع
- <Object>
windowRect: تمثيل JSON لكائن "مستطيل النافذة" استنادًا إلى حالة النافذة الجديدة.
minimizeWindow
يستدعي أمر Minimize Window عملية "تصغير" محددة لمدير النوافذ، إن وجدت، على النافذة التي تحتوي على سياق التصفح الحالي عالي المستوى. هذا عادة ما يخفي النافذة في شريط النظام.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.minimizeWindow()
الإرجاع
- <Object>
windowRect: تمثيل JSON لكائن "مستطيل النافذة" لسياق التصفح (الجديد) الحالي عالي المستوى.
fullscreenWindow
يستدعي أمر Fullscreen Window عملية "ملء الشاشة" المحددة لمدير النوافذ، إن وجدت، على النافذة التي تحتوي على سياق التصفح الحالي عالي المستوى. هذا عادة ما يزيد النافذة إلى حجم العرض الفعلي ويمكن أن يخفي عناصر واجهة المتصفح مثل شريط الأدوات.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
الاستخدام
browser.fullscreenWindow()
الإرجاع
- <Object>
windowRect: تمثيل JSON لكائن "مستطيل النافذة" لسياق التصفح (الجديد) الحالي عالي المستوى.
findElement
يستخدم أمر Find Element للعثور على عنصر في سياق التصفح الحالي يمكن استخدامه للأوامر المستقبلية. يعيد هذا الأمر تمثيل JSON للعنصر الذي يمكن تمريره إلى أمر $ لتحويل المرجع إلى عنصر WebdriverIO موسع.
أمر بروتوكول WebDriver. يمكن العثور على مزيد من التفاصيل في وثائق البروتوكول الرسمية.
هذا الأمر البروتوكولي مدمج في الطريقة المريحة التالية: $. يوصى باستخدام هذا الأمر بدلاً من ذلك.
الاستخدام
browser.findElement(using, value)
المعلمات
| الاسم | النوع | التفاصيل |
|---|---|---|
using | string | إستراتيجية تحديد موقع عنصر صالحة |
value | string | المحدد الفعلي الذي سيتم استخدامه للعثور على عنصر |