پروتکل WebDriver

newSession

فرمان New Session یک نشست WebDriver جدید با نود انتهایی ایجاد می‌کند. اگر ایجاد نشست با شکست مواجه شود، یک خطای "session not created" برگردانده می‌شود.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.newSession(capabilities)

پارامترها

نام	نوع	جزئیات
capabilities	object	یک شیء JSON، مجموعه قابلیت‌هایی که در نهایت در الگوریتم پردازش قابلیت ادغام و منطبق شده است

مقدار بازگشتی

• <Object> session: شیء حاوی sessionId و قابلیت‌های نشست WebDriver ایجاد شده.

---

deleteSession

فرمان Delete Session هر گونه متن مرور سطح بالا مرتبط با نشست فعلی را می‌بندد، اتصال را قطع می‌کند و در نهایت نشست فعلی را می‌بندد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.deleteSession(deleteSessionOpts)

پارامترها

نام	نوع	جزئیات
deleteSessionOpts اختیاری	object	شیء حاوی گزینه‌های دستور deleteSession، به عنوان مثال { shutdownDriver: boolean }

---

status

فرمان Status اطلاعاتی در مورد اینکه آیا یک انتهای راه دور در وضعیتی است که می‌تواند نشست‌های جدید ایجاد کند را برمی‌گرداند و می‌تواند به طور اختیاری شامل اطلاعات متا دلخواهی باشد که مخصوص پیاده‌سازی است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.status()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object> status: شیء حاوی وضعیت درایور.

---

getTimeouts

فرمان Get Timeouts مدت زمان‌های مهلت مرتبط با نشست فعلی را دریافت می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getTimeouts()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object> timeouts: شیء حاوی مدت زمان‌های مهلت برای script، pageLoad و مهلت‌های implicit.

---

setTimeouts

فرمان Set Timeouts مدت زمان‌های مهلت مرتبط با نشست فعلی را تنظیم می‌کند. مهلت‌هایی که می‌توان کنترل کرد در جدول مهلت‌های نشست در زیر فهرست شده‌اند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.setTimeouts(implicit, pageLoad, script)

پارامترها

نام	نوع	جزئیات
implicit اختیاری	number	عدد صحیح به میلی‌ثانیه برای مهلت انتظار ضمنی نشست
pageLoad اختیاری	number	عدد صحیح به میلی‌ثانیه برای مهلت بارگذاری صفحه نشست
script اختیاری	number	عدد صحیح به میلی‌ثانیه برای مهلت اسکریپت نشست

مثال

examples.js

loading...

View on GitHub

---

getUrl

فرمان Get Current URL آدرس URL متن مرور سطح بالای فعلی را برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getUrl()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> url: URL سند فعال در متن مرور سطح بالای فعلی

---

navigateTo

فرمان navigateTo (go) برای هدایت عامل کاربر در متن مرور سطح بالای فعلی به یک مکان جدید استفاده می‌شود.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: url. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.navigateTo(url)

پارامترها

نام	نوع	جزئیات
url	string	رشته‌ای که یک URL مطلق را نشان می‌دهد (با http(s) شروع می‌شود)، احتمالاً شامل یک قطعه (#...)، می‌تواند یک طرح محلی نیز باشد (about: و غیره)

مثال

examples.js

loading...

View on GitHub

---

back

فرمان Back باعث می‌شود مرورگر یک گام به عقب در تاریخچه نشست مشترک متن مرور سطح بالای فعلی حرکت کند. این معادل فشار دادن دکمه بازگشت در رابط کاربری مرورگر یا فراخوانی window.history.back است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.back()

مثال

examples.js

loading...

View on GitHub

---

forward

فرمان Forward باعث می‌شود مرورگر یک گام به جلو در تاریخچه نشست مشترک متن مرور سطح بالای فعلی حرکت کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.forward()

مثال

examples.js

loading...

View on GitHub

---

refresh

فرمان Refresh باعث می‌شود مرورگر صفحه را در متن مرور سطح بالای فعلی مجدداً بارگذاری کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.refresh()

مثال

examples.js

loading...

View on GitHub

---

getTitle

فرمان Get Title عنوان سند متن مرور سطح بالای فعلی را برمی‌گرداند، معادل فراخوانی document.title.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getTitle()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> title: رشته‌ای را برمی‌گرداند که همان document.title متن مرور سطح بالای فعلی است.

---

getWindowHandle

فرمان Get Window Handle دسته پنجره را برای متن مرور سطح بالای فعلی برمی‌گرداند. می‌توان از آن به عنوان آرگومان برای Switch To Window استفاده کرد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getWindowHandle()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> handle: رشته‌ای را برمی‌گرداند که دسته پنجره برای متن مرور سطح بالای فعلی است.

---

closeWindow

فرمان Close Window متن مرور سطح بالای فعلی را می‌بندد. پس از انجام، اگر دیگر متن مرور سطح بالایی باز نباشد، خود نشست WebDriver بسته می‌شود.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.closeWindow()

مثال

examples.js

loading...

View on GitHub

---

switchToWindow

فرمان Switch To Window برای انتخاب متن مرور سطح بالای فعلی برای نشست فعلی استفاده می‌شود، یعنی آنچه برای پردازش دستورات استفاده خواهد شد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: switchWindow. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.switchToWindow(handle)

پارامترها

نام	نوع	جزئیات
handle	string	رشته‌ای که یک دسته پنجره را نشان می‌دهد، باید یکی از رشته‌هایی باشد که در فراخوانی getWindowHandles برگردانده شده است

مثال

examples.js

loading...

View on GitHub

---

createWindow

یک متن مرور سطح بالای جدید ایجاد می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.createWindow(type)

پارامترها

نام	نوع	جزئیات
type	string	اگر پنجره تازه ایجاد شده یک پنجره سطح سیستم عامل را با متن مرور فعلی به اشتراک می‌گذارد، به 'tab' تنظیم شود، در غیر این صورت 'window'.

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object> window: شیء پنجره جدید حاوی 'handle' با مقدار دسته و 'type' با مقدار نوع پنجره ایجاد شده

---

getWindowHandles

فرمان Get Window Handles یک لیست از دسته‌های پنجره برای هر متن مرور سطح بالای باز برمی‌گرداند. ترتیبی که در آن دسته‌های پنجره برگردانده می‌شوند اختیاری است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getWindowHandles()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <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[]	محدوده صفحات. پیش‌فرض []

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <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 نیست)، یک عدد، نشان‌دهنده شاخص شیء پنجره مربوط به یک فریم، یک شیء Element که با استفاده از findElement دریافت شده است.

مثال

examples.js

loading...

View on GitHub

---

switchToParentFrame

فرمان Switch to Parent Frame متن مرور فعلی را برای دستورات آینده به والد متن مرور فعلی تنظیم می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.switchToParentFrame()

مثال

examples.js

loading...

View on GitHub

---

getWindowRect

فرمان Get Window Rect اندازه و موقعیت پنجره سیستم عامل مربوط به متن مرور سطح بالای فعلی را روی صفحه نمایش برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: getWindowSize. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.getWindowRect()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object> windowRect: یک نمایش JSON از یک شیء "window rect". این دارای 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	ارتفاع ابعاد خارجی متن مرور سطح بالا، شامل کروم مرورگر و غیره...

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object> windowRect: یک نمایش JSON از یک شیء "window rect" بر اساس وضعیت جدید پنجره.

---

maximizeWindow

فرمان Maximize Window عملیات "maximize" مختص مدیر پنجره، در صورت وجود، را روی پنجره حاوی متن مرور سطح بالای فعلی فراخوانی می‌کند. این معمولاً پنجره را به حداکثر اندازه موجود بدون رفتن به حالت تمام‌صفحه افزایش می‌دهد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.maximizeWindow()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object> windowRect: یک نمایش JSON از یک شیء "window rect" بر اساس وضعیت جدید پنجره.

---

minimizeWindow

فرمان Minimize Window عملیات "minimize" مختص مدیر پنجره، در صورت وجود، را روی پنجره حاوی متن مرور سطح بالای فعلی فراخوانی می‌کند. این معمولاً پنجره را در سینی سیستم پنهان می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.minimizeWindow()

مقدار بازگشتی

• <Object> windowRect: یک نمایش JSON از یک شیء "window rect" از متن مرور سطح بالای (جدید) فعلی.

---

fullscreenWindow

فرمان Fullscreen Window عملیات "full screen" مختص مدیر پنجره، در صورت وجود، را روی پنجره حاوی متن مرور سطح بالای فعلی فراخوانی می‌کند. این معمولاً پنجره را به اندازه نمایشگر فیزیکی افزایش می‌دهد و می‌تواند عناصر کروم مرورگر مانند نوارابزارها را پنهان کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.fullscreenWindow()

مقدار بازگشتی

• <Object> windowRect: یک نمایش JSON از یک شیء "window rect" از متن مرور سطح بالای (جدید) فعلی.

---

findElement

فرمان Find Element برای یافتن یک عنصر در متن مرور فعلی استفاده می‌شود که می‌تواند برای دستورات آینده استفاده شود. این دستور نمایش JSON عنصر را برمی‌گرداند که می‌تواند به دستور $ منتقل شود تا مرجع را به یک عنصر گسترش یافته WebdriverIO تبدیل کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: $. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.findElement(using, value)

پارامترها

نام	نوع	جزئیات
using	string	یک استراتژی مکان‌یابی عنصر معتبر
value	string	انتخابگر واقعی که برای یافتن یک عنصر استفاده خواهد شد

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <object> element: یک نمایش JSON از یک شیء عنصر، به عنوان مثال { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementFromShadowRoot

فرمان Find Element From Shadow Root برای یافتن یک عنصر در ریشه سایه یک عنصر استفاده می‌شود که می‌تواند برای دستورات آینده استفاده شود. این دستور نمایش JSON عنصر را برمی‌گرداند که می‌تواند به دستور $ منتقل شود تا مرجع را به یک عنصر گسترش یافته WebdriverIO تبدیل کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: shadow$. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.findElementFromShadowRoot(shadowId, using, value)

پارامترها

نام	نوع	جزئیات
shadowId	String	شناسه عنصر از یک عنصر ریشه سایه
using	string	یک استراتژی مکان‌یابی عنصر معتبر
value	string	انتخابگر واقعی که برای یافتن یک عنصر استفاده خواهد شد

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <object> element: یک نمایش JSON از یک شیء سایه عنصر، به عنوان مثال { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElements

فرمان Find Elements برای یافتن عناصر در متن مرور فعلی استفاده می‌شود که می‌توانند برای دستورات آینده استفاده شوند. این دستور آرایه‌ای از نمایش JSON عناصر را برمی‌گرداند که می‌تواند به دستور $ منتقل شود تا مرجع را به یک عنصر گسترش یافته WebdriverIO تبدیل کند (به findElement مراجعه کنید).

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: $$. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.findElements(using, value)

پارامترها

نام	نوع	جزئیات
using	string	یک استراتژی مکان‌یابی عنصر معتبر
value	string	انتخابگر واقعی که برای یافتن یک عنصر استفاده خواهد شد

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <object[]> elements: یک لیست JSON (احتمالاً خالی) از نمایش‌های یک شیء عنصر، به عنوان مثال [{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }].

---

findElementsFromShadowRoot

فرمان Find Elements برای یافتن عناصر درون ریشه سایه یک عنصر استفاده می‌شود که می‌توانند برای دستورات آینده استفاده شوند. این دستور آرایه‌ای از نمایش JSON عناصر را برمی‌گرداند که می‌تواند به دستور $ منتقل شود تا مرجع را به یک عنصر گسترش یافته WebdriverIO تبدیل کند (به findElement مراجعه کنید).

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: shadow$$. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.findElementsFromShadowRoot(shadowId, using, value)

پارامترها

نام	نوع	جزئیات
shadowId	String	شناسه عنصر از یک عنصر ریشه سایه
using	string	یک استراتژی مکان‌یابی عنصر معتبر
value	string	انتخابگر واقعی که برای یافتن یک عنصر استفاده خواهد شد

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <object[]> elements: یک لیست JSON (احتمالاً خالی) از نمایش‌های یک شیء عنصر، به عنوان مثال { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementFromElement

فرمان Find Element From Element برای یافتن یک عنصر از یک عنصر وب در متن مرور فعلی استفاده می‌شود که می‌تواند برای دستورات آینده استفاده شود. این دستور نمایش JSON عنصر را برمی‌گرداند که می‌تواند به دستور $ منتقل شود تا مرجع را به یک عنصر گسترش یافته WebdriverIO تبدیل کند (به findElement مراجعه کنید).

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: $. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.findElementFromElement(elementId, using, value)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است
using	string	یک استراتژی مکان‌یابی عنصر معتبر
value	string	انتخابگر واقعی که برای یافتن یک عنصر استفاده خواهد شد

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <object> element: یک نمایش JSON از یک شیء عنصر، به عنوان مثال { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementsFromElement

فرمان Find Elements From Element برای یافتن عناصر از یک عنصر وب در متن مرور فعلی استفاده می‌شود که می‌توانند برای دستورات آینده استفاده شوند. این دستور آرایه‌ای از نمایش JSON عناصر را برمی‌گرداند که می‌تواند به دستور $ منتقل شود تا مرجع را به یک عنصر گسترش یافته WebdriverIO تبدیل کند (به findElement مراجعه کنید).

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: $$. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.findElementsFromElement(elementId, using, value)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است
using	string	یک استراتژی مکان‌یابی عنصر معتبر
value	string	انتخابگر واقعی که برای یافتن یک عنصر استفاده خواهد شد

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <object[]> elements: یک لیست JSON (احتمالاً خالی) از نمایش‌های یک شیء عنصر، به عنوان مثال [{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }].

---

getElementShadowRoot

شیء ریشه سایه یک عنصر را دریافت می‌کند. شیء نتیجه می‌تواند برای بازیابی عناصر درون این ریشه سایه مثلاً با استفاده از findElementFromShadowRoots یا findElementsFromShadowRoots استفاده شود.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: shadow$. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.getElementShadowRoot(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> shadowRoot: یک نمایش JSON از یک ریشه سایه عنصر، به عنوان مثال { 'shadow-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

getActiveElement

Get Active Element عنصر فعال سند عنصر متن مرور فعلی را برمی‌گرداند. این دستور نمایش JSON عنصر را برمی‌گرداند که می‌تواند به دستور $ منتقل شود تا مرجع را به یک عنصر گسترش یافته WebdriverIO تبدیل کند (به findElement مراجعه کنید).

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getActiveElement()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> element: یک نمایش JSON از یک شیء عنصر، به عنوان مثال { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

isElementSelected

Is Element Selected تعیین می‌کند که آیا عنصر ارجاع شده انتخاب شده است یا خیر. این عملیات فقط در عناصر ورودی با حالت‌های دکمه رادیویی و چک باکس، یا عناصر گزینه‌ای معنی دارد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: isSelected. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.isElementSelected(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Boolean> isSelected: true یا false بر اساس وضعیت انتخاب.

---

isElementDisplayed

Is Element Displayed قابلیت مشاهده یک عنصر را تعیین می‌کند که توسط آنچه از نظر چشم انسان قابل مشاهده است هدایت می‌شود. در این زمینه، قابلیت نمایش یک عنصر به خصوصیات سبک visibility یا display مربوط نیست.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: isDisplayed. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.isElementDisplayed(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Boolean> isDisplayed: true یا false بر اساس وضعیت قابل مشاهده.

---

getElementAttribute

فرمان Get Element Attribute صفت یک عنصر وب را برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: getAttribute. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.getElementAttribute(elementId, name)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است
name	String	نام مقدار صفت برای بازیابی

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> attribute: صفت نامیده شده عنصر.

---

getElementProperty

فرمان Get Element Property نتیجه دریافت یک خاصیت از یک عنصر را برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: getProperty. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.getElementProperty(elementId, name)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است
name	String	نام خاصیت صفت برای بازیابی

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> property: خاصیت نامیده شده عنصر، که با فراخوانی GetOwnProperty روی شیء عنصر دسترسی پیدا می‌کند.

---

getElementCSSValue

فرمان Get Element CSS Value مقدار محاسبه شده خاصیت CSS داده شده از عنصر وب داده شده را بازیابی می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: getCSSProperty. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.getElementCSSValue(elementId, propertyName)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است
propertyName	String	نام خاصیت CSS برای بازیابی

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> cssValue: مقدار محاسبه شده پارامتر مربوط به نام خاصیت از اعلامیه‌های سبک عنصر (مگر اینکه نوع سند xml باشد، در این صورت مقدار برگشتی به سادگی رشته خالی است).

---

getElementText

فرمان Get Element Text قصد دارد متن یک عنصر را "به صورت ارائه شده" برگرداند. متن ارائه شده یک عنصر همچنین برای پیدا کردن عناصر با متن پیوند و متن پیوند جزئی استفاده می‌شود.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getElementText(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> text: متن قابل مشاهده عنصر (شامل عناصر فرزند)، با دنبال کردن الگوریتم تعریف شده در Selenium Atoms برای bot.dom.getVisibleText.

---

getElementTagName

فرمان Get Element Tag Name نام عنصر واجد شرایط از عنصر وب داده شده را برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: getTagName. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.getElementTagName(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> text: صفت tagName عنصر.

---

getElementRect

فرمان Get Element Rect ابعاد و مختصات عنصر وب داده شده را برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متدهای مناسب زیر جاسازی شده است: getSize, getLocation. توصیه می‌شود به جای آن از این دستورات استفاده کنید.

استفاده

browser.getElementRect(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object> elementRect: یک شیء JSON که موقعیت و مستطیل محیطی عنصر را نشان می‌دهد.

---

isElementEnabled

Is Element Enabled تعیین می‌کند که آیا عنصر ارجاع شده فعال است یا خیر. این عملیات فقط در کنترل‌های فرم معنی دارد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: isEnabled. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.isElementEnabled(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Boolean> isEnabled: اگر عنصر در یک سند xml است، یا کنترل فرم غیرفعال است: false، در غیر این صورت، true.

---

elementClick

فرمان Element Click عنصر را به دید می‌آورد اگر هنوز قابل تعامل با اشاره‌گر نیست، و روی نقطه مرکزی قابل مشاهده آن کلیک می‌کند. اگر نقطه مرکزی عنصر توسط عنصر دیگری مسدود شده باشد، یک خطای تداخل کلیک عنصر برگردانده می‌شود. اگر عنصر خارج از دید باشد، یک خطای عنصر غیرقابل تعامل برگردانده می‌شود.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: click. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.elementClick(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

---

elementClear

فرمان Element Clear یک عنصر قابل ویرایش یا قابل بازنشانی را به دید می‌آورد و سپس تلاش می‌کند فایل‌های انتخاب شده یا محتوای متنی آن را پاک کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: clearValue. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.elementClear(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مثال

examples.js

loading...

View on GitHub

---

elementSendKeys

فرمان Element Send Keys عنصر کنترل فرم را به دید می‌آورد و سپس کلیدهای ارائه شده را به عنصر ارسال می‌کند. در صورتی که عنصر قابل تعامل با صفحه کلید نباشد، یک خطای عنصر غیرقابل تعامل برگردانده می‌شود.

وضعیت ورودی کلید مورد استفاده برای ورودی ممکن است در میانه "تایپ" با ارسال کلید null که U+E000 (NULL) است، پاک شود.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متدهای مناسب زیر جاسازی شده است: addValue, setValue. توصیه می‌شود به جای آن از این دستورات استفاده کنید.

استفاده

browser.elementSendKeys(elementId, text)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است
text	string	رشته‌ای برای ارسال به عنوان ضربات کلید به عنصر

مثال

examples.js

loading...

View on GitHub

---

getPageSource

فرمان Get Page Source یک رشته سریالی‌سازی شده از DOM سند فعال متن مرور فعلی را برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getPageSource()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> pageSource: DOM سند فعال متن مرور فعلی

---

executeScript

فرمان Execute Script یک تابع JavaScript را در متن مرور فعلی اجرا می‌کند و مقدار بازگشتی تابع را برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: execute. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.executeScript(script, args)

پارامترها

نام	نوع	جزئیات
script	string	یک رشته، بدنه تابع Javascript که می‌خواهید اجرا شود
args	string, object, number, boolean, null, undefined[]	آرایه‌ای از مقادیر JSON که از سریالی‌سازی خارج می‌شوند و به عنوان آرگومان به تابع شما منتقل می‌شوند

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <*> result: یا مقدار برگشتی اسکریپت شما، یا تحقق Promise برگردانده شده توسط اسکریپت شما، یا خطایی که دلیل رد Promise برگردانده شده توسط اسکریپت شما بود.

---

executeAsyncScript

فرمان Execute Async Script باعث می‌شود JavaScript به عنوان یک تابع بی‌نام اجرا شود. برخلاف فرمان Execute Script، نتیجه تابع نادیده گرفته می‌شود. در عوض، یک آرگومان اضافی به عنوان آرگومان نهایی به تابع ارائه می‌شود. این یک تابع است که، هنگام فراخوانی، اولین آرگومان خود را به عنوان پاسخ برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

اطلاعات

این دستور پروتکل در متد مناسب زیر جاسازی شده است: executeAsync. توصیه می‌شود به جای آن از این دستور استفاده کنید.

استفاده

browser.executeAsyncScript(script, args)

پارامترها

نام	نوع	جزئیات
script	string	یک رشته، بدنه تابع Javascript که می‌خواهید اجرا شود
args	string, object, number, boolean, null, undefined[]	آرایه‌ای از مقادیر JSON که از سریالی‌سازی خارج می‌شوند و به عنوان آرگومان به تابع شما منتقل می‌شوند

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <*> result: یا مقدار برگشتی اسکریپت شما، یا تحقق Promise برگردانده شده توسط اسکریپت شما، یا خطایی که دلیل رد Promise برگردانده شده توسط اسکریپت شما بود.

---

getAllCookies

فرمان Get All Cookies تمام کوکی‌های مرتبط با آدرس سند فعال متن مرور فعلی را برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getAllCookies()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object[]> cookies: یک لیست از کوکی‌های سریالی‌سازی شده. هر کوکی سریالی‌سازی شده تعدادی فیلد اختیاری دارد که ممکن است علاوه بر name و value برگردانده شوند یا نشوند.

---

addCookie

فرمان Add Cookie یک کوکی واحد را به انبار کوکی مرتبط با آدرس سند فعال اضافه می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.addCookie(cookie)

پارامترها

نام	نوع	جزئیات
cookie	object	یک شیء JSON که یک کوکی را نشان می‌دهد. باید حداقل فیلدهای name و value را داشته باشد و می‌تواند بیشتر، از جمله زمان انقضا و غیره داشته باشد

مثال

examples.js

loading...

View on GitHub

---

deleteAllCookies

فرمان Delete All Cookies امکان حذف تمام کوکی‌های مرتبط با آدرس سند فعال را فراهم می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.deleteAllCookies()

مثال

examples.js

loading...

View on GitHub

---

getNamedCookie

فرمان Get Named Cookie کوکی با نام درخواست شده را از کوکی‌های مرتبط در انبار کوکی سند فعال متن مرور فعلی برمی‌گرداند. اگر هیچ کوکی پیدا نشود، یک خطای "no such cookie" برگردانده می‌شود.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getNamedCookie(name)

پارامترها

نام	نوع	جزئیات
name	String	نام کوکی برای بازیابی

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <Object> cookie: یک کوکی سریالی‌سازی شده، با فیلدهای name و value. تعدادی فیلد اختیاری مانند path، domain و expiry-time نیز ممکن است وجود داشته باشند.

---

deleteCookie

فرمان Delete Cookie به شما امکان می‌دهد یا یک کوکی واحد را با پارامتر name حذف کنید، یا تمام کوکی‌های مرتبط با آدرس سند فعال را اگر name نامشخص باشد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.deleteCookie(name)

پارامترها

نام	نوع	جزئیات
name	String	نام کوکی برای حذف

مثال

examples.js

loading...

View on GitHub

---

performActions

فرمان Perform Actions برای اجرای اقدامات پیچیده کاربر استفاده می‌شود. برای جزئیات بیشتر به مشخصات مراجعه کنید.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.performActions(actions)

پارامترها

نام	نوع	جزئیات
actions	object[]	لیستی از اشیاء که هر کدام یک منبع ورودی و اقدامات مرتبط با آن را نشان می‌دهد

---

releaseActions

فرمان Release Actions برای آزاد کردن تمام کلیدها و دکمه‌های اشاره‌گر که در حال حاضر فشرده هستند استفاده می‌شود. این باعث می‌شود رویدادها به گونه‌ای ارسال شوند که انگار وضعیت با یک سری اقدامات صریح آزاد شده است. همچنین تمام وضعیت داخلی دستگاه‌های مجازی را پاک می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.releaseActions()

---

dismissAlert

فرمان Dismiss Alert یک گفتگوی ساده را در صورت وجود رد می‌کند، در غیر این صورت خطا می‌دهد. یک درخواست برای رد یک پیام اخطار کاربر، که ممکن است الزاماً دکمه رد نداشته باشد، همان تأثیر پذیرش آن را دارد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.dismissAlert()

مثال

examples.js

loading...

View on GitHub

---

acceptAlert

فرمان Accept Alert یک گفتگوی ساده را در صورت وجود می‌پذیرد، در غیر این صورت خطا می‌دهد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.acceptAlert()

---

getAlertText

فرمان Get Alert Text پیام پیام اخطار کاربر فعلی را برمی‌گرداند. اگر هیچ پیام اخطار کاربر فعلی وجود نداشته باشد، یک خطا برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getAlertText()

مثال

examples.js

loading...

View on GitHub

مقدار بازگشتی

• <string> alertText: پیام پیام اخطار کاربر.

---

sendAlertText

فرمان Send Alert Text فیلد متن یک پیام اخطار کاربر window.prompt را به مقدار داده شده تنظیم می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.sendAlertText(text)

پارامترها

نام	نوع	جزئیات
text	string	رشته‌ای برای تنظیم پیام به آن

---

takeScreenshot

فرمان Take Screenshot یک عکس از منظره متن مرور سطح بالای فعلی می‌گیرد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.takeScreenshot()

مقدار بازگشتی

• <string> screenshot: داده تصویر PNG کدگذاری شده با base64 که شامل عکس از منظره اولیه است.

---

takeElementScreenshot

فرمان Take Element Screenshot یک عکس از ناحیه قابل مشاهده محصور شده توسط مستطیل محیطی یک عنصر می‌گیرد.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.takeElementScreenshot(elementId, scroll)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است
scroll اختیاری	boolean	اسکرول به نمای عنصر. پیش‌فرض: true

مقدار بازگشتی

• <string> screenshot: داده تصویر PNG کدگذاری شده با base64 که شامل عکس از ناحیه قابل مشاهده مستطیل محیطی یک عنصر پس از اسکرول آن به نما است.

---

getElementComputedRole

نقش WAI-ARIA محاسبه شده یک عنصر را دریافت می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getElementComputedRole(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مقدار بازگشتی

• <string> role: نتیجه محاسبه نقش WAI-ARIA عنصر.

---

getElementComputedLabel

نام قابل دسترسی عنصر را دریافت می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getElementComputedLabel(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه یک عنصر که در فراخوانی قبلی Find Element(s) برگردانده شده است

مقدار بازگشتی

• <string> label: نتیجه محاسبه نام و توضیح دسترسی برای نام دسترسی عنصر.

---

setPermissions

تغییر وضعیت مجوز یک PermissionDescriptor توسط کاربر را شبیه‌سازی می‌کند. توجه: این ویژگی هنوز در همه مرورگرها قرار نگرفته است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.setPermissions(descriptor, state, oneRealm)

پارامترها

نام	نوع	جزئیات
descriptor	object	هر ویژگی قدرتمند یک یا چند جنبه دارد که وب‌سایت‌ها می‌توانند برای دسترسی به آن درخواست مجوز کنند. برای توصیف این جنبه‌ها، هر ویژگی یک زیرنوع از PermissionDescriptor را به عنوان نوع توصیف‌کننده مجوز خود تعریف می‌کند. توجه: این ویژگی هنوز در همه مرورگرها قرار نگرفته است.
state	string	تعیین می‌کند آیا مجوز اعطا، رد یا درخواست می‌شود.
oneRealm اختیاری	boolean	آیا مجوزها به تمام محیط‌های اجرایی اعمال شوند یا خیر.

مثال‌ها

// تنظیم مجوزهای midi
browser.setPermissions(
  { name: 'midi', sysex: true },
  'granted' // می‌تواند "denied" یا "prompt" نیز باشد
);

// تنظیم مجوزهای کلیپ‌بورد
browser.setPermissions({ name: 'clipboard-read' }, 'granted');
// اکنون می‌توانید کلیپ‌بورد را بخوانید، مثلاً
const clipboardText = await browser.execute(() => navigator.clipboard.readText());

---

generateTestReport

یک گزارش برای آزمایش تولید می‌کند. افزونه برای Reporting API. توجه: این ویژگی هنوز در همه مرورگرها قرار نگرفته است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.generateTestReport(message, group)

پارامترها

نام	نوع	جزئیات
message	string	پیامی که در گزارش نمایش داده خواهد شد.
group اختیاری	string	گروه نقطه پایانی را برای تحویل گزارش مشخص می‌کند.

---

createMockSensor

یک سنسور ساختگی برای شبیه‌سازی سنسورهایی مانند سنسور نور محیطی ایجاد می‌کند. توجه: این ویژگی هنوز در همه مرورگرها قرار نگرفته است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.createMockSensor(mockSensorType, maxSamplingFrequency, minSamplingFrequency)

پارامترها

نام	نوع	جزئیات
mockSensorType	string	نوع API سنسور برای شبیه‌سازی، مثلاً 'ambient-light'
maxSamplingFrequency اختیاری	number	یک عدد اعشاری که فرکانس را به هرتز نشان می‌دهد و برای تنظیم حداکثر فرکانس نمونه‌برداری پشتیبانی شده برای سنسور ساختگی مربوطه استفاده می‌شود.
minSamplingFrequency اختیاری	number	یک عدد اعشاری که فرکانس را به هرتز نشان می‌دهد و برای تنظیم حداقل فرکانس نمونه‌برداری پشتیبانی شده برای سنسور ساختگی مربوطه استفاده می‌شود.

---

getMockSensor

اطلاعاتی در مورد نوع خاصی از سنسور ساختگی بازیابی می‌کند. توجه: این ویژگی هنوز در همه مرورگرها قرار نگرفته است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getMockSensor(type)

پارامترها

نام	نوع	جزئیات
type	String	نوع سنسور ساختگی برای بازیابی اطلاعات.

مقدار بازگشتی

• <object> sensorReading: مقادیر خواندن سنسور ساختگی.

---

updateMockSensor

نوع سنسور ساختگی را به‌روزرسانی می‌کند. توجه: این ویژگی هنوز در همه مرورگرها قرار نگرفته است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.updateMockSensor(type, mockSensorType, maxSamplingFrequency, minSamplingFrequency)

پارامترها

نام	نوع	جزئیات
type	String	نوع سنسور ساختگی برای به‌روزرسانی اطلاعات.
mockSensorType	string	نوع API سنسور برای شبیه‌سازی، مثلاً 'ambient-light'
maxSamplingFrequency اختیاری	number	یک عدد اعشاری که فرکانس را به هرتز نشان می‌دهد و برای تنظیم حداکثر فرکانس نمونه‌برداری پشتیبانی شده برای سنسور ساختگی مربوطه استفاده می‌شود.
minSamplingFrequency اختیاری	number	یک عدد اعشاری که فرکانس را به هرتز نشان می‌دهد و برای تنظیم حداقل فرکانس نمونه‌برداری پشتیبانی شده برای سنسور ساختگی مربوطه استفاده می‌شود.

---

deleteMockSensor

فرمان Delete Session هر متن مرور سطح بالا مرتبط با نشست فعلی را می‌بندد، اتصال را قطع می‌کند و در نهایت نشست فعلی را می‌بندد. توجه: این ویژگی هنوز در همه مرورگرها قرار نگرفته است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.deleteMockSensor(type)

پارامترها

نام	نوع	جزئیات
type	String	نوع سنسور ساختگی برای حذف.

---

setTimeZone

تغییر منطقه زمانی را برای اهداف آزمایش شبیه‌سازی می‌کند. توجه: این ویژگی هنوز در همه مرورگرها قرار نگرفته است.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.setTimeZone(time_zone)

پارامترها

نام	نوع	جزئیات
time_zone	string	نام منطقه زمانی، مثلاً Asia/Tokyo

---

addVirtualAuthenticator

یک احراز هویت مجازی نرم‌افزاری ایجاد می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.addVirtualAuthenticator(protocol, transport, hasResidentKey, hasUserVerification, isUserConsenting, isUserVerified, extensions, uvm)

پارامترها

نام	نوع	جزئیات
protocol اختیاری	string	مقادیر معتبر: 'ctap1/u2f'، 'ctap2'، 'ctap2_1'.
transport اختیاری	string	مقادیر معتبر: 'usb'، 'nfc'، 'ble' یا 'internal'.
hasResidentKey اختیاری	boolean	مقادیر معتبر: true، false.
hasUserVerification اختیاری	boolean	مقادیر معتبر: true، false.
isUserConsenting اختیاری	boolean	مقادیر معتبر: true، false.
isUserVerified اختیاری	boolean	مقادیر معتبر: یک آرایه حاوی شناسه‌های افزونه.
extensions اختیاری	string[]	مقادیر معتبر: تا 3 ورودی روش تأیید کاربر.
uvm اختیاری	object[]

مقدار بازگشتی

• <string> authenticatorId: شناسه رشته‌ای احراز هویت‌کننده را برمی‌گرداند.

---

removeVirtualAuthenticator

یک احراز هویت‌کننده مجازی که قبلاً ایجاد شده است را حذف می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.removeVirtualAuthenticator(authenticatorId)

پارامترها

نام	نوع	جزئیات
authenticatorId	String	شناسه احراز هویت‌کننده

---

addCredential

یک منبع اعتبار کلید عمومی را به یک احراز هویت‌کننده مجازی موجود تزریق می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.addCredential(authenticatorId, credentialId, isResidentCredential, rpId, privateKey, userHandle, signCount, largeBlob)

پارامترها

نام	نوع	جزئیات
authenticatorId	String	شناسه احراز هویت‌کننده
credentialId	string	شناسه اعتبار کدگذاری شده با استفاده از کدگذاری Base64url.
isResidentCredential	boolean	اگر به true تنظیم شود، یک اعتبار قابل کشف در سمت مشتری ایجاد می‌شود. اگر به false تنظیم شود، در عوض یک اعتبار سمت سرور ایجاد می‌شود.
rpId	string	شناسه طرف متکی که اعتبار به آن محدود شده است.
privateKey	string	یک بسته کلید نامتقارن حاوی یک کلید خصوصی واحد مطابق با [RFC5958]، کدگذاری شده با استفاده از کدگذاری Base64url.
userHandle	string	userHandle مرتبط با اعتبار کدگذاری شده با استفاده از کدگذاری Base64url. این خاصیت ممکن است تعریف نشده باشد.
signCount	number	مقدار اولیه برای یک شمارنده امضا مرتبط با منبع اعتبار کلید عمومی.
largeBlob اختیاری	string	بلاب بزرگ و مرتبط با اعتبار برای منبع اعتبار کلید عمومی، کدگذاری شده با استفاده از کدگذاری Base64url. این خاصیت ممکن است تعریف نشده باشد.

---

getCredentials

یک شیء پارامترهای اعتبار برای هر منبع اعتبار کلید عمومی ذخیره شده در یک احراز هویت‌کننده مجازی، صرف نظر از اینکه آیا با استفاده از Add Credential یا navigator.credentials.create() ذخیره شده‌اند، برمی‌گرداند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.getCredentials(authenticatorId)

پارامترها

نام	نوع	جزئیات
authenticatorId	String	شناسه احراز هویت‌کننده

مقدار بازگشتی

• <object[]> credentials: آرایه‌ای از اعتبارها را برمی‌گرداند.

---

removeAllCredentials

تمام منابع اعتبار کلید عمومی ذخیره شده در یک احراز هویت‌کننده مجازی را حذف می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.removeAllCredentials(authenticatorId)

پارامترها

نام	نوع	جزئیات
authenticatorId	String	شناسه احراز هویت‌کننده

---

removeCredential

یک منبع اعتبار کلید عمومی ذخیره شده در یک احراز هویت‌کننده مجازی را حذف می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.removeCredential(authenticatorId, credentialId)

پارامترها

نام	نوع	جزئیات
authenticatorId	String	شناسه احراز هویت‌کننده
credentialId	String	شناسه اعتبار

---

setUserVerified

فرمان افزونه Set User Verified ویژگی isUserVerified را روی احراز هویت‌کننده مجازی تنظیم می‌کند.

دستور پروتکل WebDriver است. جزئیات بیشتر در مستندات رسمی پروتکل قابل مشاهده است.

استفاده

browser.setUserVerified(authenticatorId)

پارامترها

نام	نوع	جزئیات
authenticatorId	String	شناسه احراز هویت‌کننده