اپیوم

getAppiumContext

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getAppiumContext()

خروجی‌ها

• <Context> context: یک رشته که نمایانگر context فعلی است یا null که نمایانگر 'بدون context' است

---

switchAppiumContext

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.switchAppiumContext(name)

پارامترها

نام	نوع	جزئیات
name	string	رشته‌ای که نمایانگر یک context در دسترس است

---

getAppiumContexts

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getAppiumContexts()

خروجی‌ها

• <Context[]> contexts: آرایه‌ای از رشته‌ها که نمایانگر context‌های در دسترس است، مانند 'WEBVIEW'، یا 'NATIVE'

---

shake

اجرای یک عمل تکان دادن روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.shake()

پشتیبانی

---

lock

قفل کردن دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.lock(seconds)

پارامترها

نام	نوع	جزئیات
seconds اختیاری	number	مدت زمان قفل ماندن صفحه (فقط iOS)

پشتیبانی

---

unlock

باز کردن قفل دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.unlock()

پشتیبانی

---

isLocked

بررسی اینکه آیا دستگاه قفل است یا خیر.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.isLocked()

خروجی‌ها

• <boolean> isLocked: اگر دستگاه قفل باشد True و در غیر این صورت false

پشتیبانی

---

startRecordingScreen

شروع ضبط صفحه نمایش.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.startRecordingScreen(options)

پارامترها

نام	نوع	جزئیات
options اختیاری	object	پارامترهای دستور که می‌تواند شامل کلیدهایی مانند: remotePath، username، password، method، forceRestart، timeLimit، videoType، videoQuality، videoFps، bitRate، videoSize، bugReport باشد (برای توضیحات بیشتر به مستندات Appium مراجعه کنید)

پشتیبانی

---

stopRecordingScreen

توقف ضبط صفحه نمایش

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.stopRecordingScreen(remotePath, username, password, method)

پارامترها

نام	نوع	جزئیات
remotePath اختیاری	string	مسیر مکان از راه دور که ویدیوی نتیجه باید آنجا آپلود شود. پروتکل‌های زیر پشتیبانی می‌شوند http/https، ftp. این گزینه فقط زمانی اثر دارد که فرآیند ضبط صفحه در حال انجام باشد و پارامتر forceRestart روی true تنظیم نشده باشد. مقدار null یا رشته خالی (تنظیم پیش‌فرض) به این معنی است که محتوای فایل نتیجه باید به صورت Base64 کدگذاری شود.
username اختیاری	string	نام کاربری برای احراز هویت از راه دور.
password اختیاری	string	رمز عبور برای احراز هویت از راه دور.
method اختیاری	string	نام روش آپلود multipart http. به طور پیش‌فرض از 'PUT' استفاده می‌شود.

خروجی‌ها

• <string> response: رشته کدگذاری شده با Base64. اگر remote_path تنظیم شده باشد، پاسخ یک رشته خالی است

پشتیبانی

---

getPerformanceDataTypes

انواع اطلاعات وضعیت سیستم را که پشتیبانی می‌شوند مانند cpu، حافظه، ترافیک شبکه و باتری برمی‌گرداند.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getPerformanceDataTypes()

خروجی‌ها

• <string[]> performanceTypes: انواع داده‌های عملکرد در دسترس (cpuinfo|batteryinfo|networkinfo|memoryinfo)

پشتیبانی

---

getPerformanceData

اطلاعات وضعیت سیستم را که پشتیبانی می‌شوند مانند cpu، حافظه، ترافیک شبکه و باتری برمی‌گرداند.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

پارامترها

نام	نوع	جزئیات
packageName	string	نام پکیج برنامه
dataType	string	نوع وضعیت سیستم که می‌خواهید خوانده شود. باید یکی از انواع داده‌های عملکرد پشتیبانی شده باشد
dataReadTimeout اختیاری	number	تعداد تلاش‌ها برای خواندن

خروجی‌ها

• <string[]> performanceData: نوع اطلاعات وضعیت سیستم که پشتیبانی می‌شود مانند cpu، حافظه، ترافیک شبکه و باتری

پشتیبانی

---

pressKeyCode

فشردن یک کلید خاص روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.pressKeyCode(keycode, metastate, flags)

پارامترها

نام	نوع	جزئیات
keycode	number	کد کلید برای فشردن
metastate اختیاری	number	حالت متا برای فشردن کد کلید با آن
flags اختیاری	number	پرچم‌ها برای فشردن کلید

پشتیبانی

---

longPressKeyCode

فشردن و نگه داشتن یک کد کلید خاص روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.longPressKeyCode(keycode, metastate, flags)

پارامترها

نام	نوع	جزئیات
keycode	number	کد کلید برای فشردن روی دستگاه
metastate اختیاری	number	متااستیت برای فشردن کلید
flags اختیاری	number	پرچم‌ها برای فشردن کلید

پشتیبانی

---

sendKeyEvent

ارسال یک کد کلید به دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.sendKeyEvent(keycode, metastate)

پارامترها

نام	نوع	جزئیات
keycode	string	کد کلید برای فشردن
metastate اختیاری	string	حالت متا برای فشردن کد کلید با آن

پشتیبانی

---

rotateDevice

چرخاندن دستگاه در سه بعد.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.rotateDevice(x, y, z)

پارامترها

نام	نوع	جزئیات
x	number	آفست x برای استفاده در مرکز حرکت چرخشی
y	number	آفست y برای استفاده در مرکز حرکت چرخشی
z	number	آفست z برای استفاده در مرکز حرکت چرخشی

پشتیبانی

---

getCurrentActivity

دریافت نام فعالیت فعلی در اندروید.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getCurrentActivity()

خروجی‌ها

• <string> activity: نام فعالیت فعلی

پشتیبانی

---

getCurrentPackage

دریافت نام پکیج فعلی اندروید.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getCurrentPackage()

خروجی‌ها

• <string> package: نام پکیج فعلی

پشتیبانی

---

installApp

نصب برنامه داده شده روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.installApp(appPath)

پارامترها

نام	نوع	جزئیات
appPath	string	مسیر به فایل برنامه .apk

پشتیبانی

---

activateApp

فعال‌سازی برنامه داده شده روی دستگاه

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.activateApp(appId)

پارامترها

نام	نوع	جزئیات
appId	string	شناسه برنامه (شناسه پکیج برای اندروید، شناسه باندل برای iOS)

پشتیبانی

---

removeApp

حذف یک برنامه از دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.removeApp(appId)

پارامترها

نام	نوع	جزئیات
appId	string	شناسه برنامه (شناسه پکیج برای اندروید، شناسه باندل برای iOS)

پشتیبانی

---

terminateApp

خاتمه دادن به برنامه مشخص شده روی دستگاه

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.terminateApp(appId, options)

پارامترها

نام	نوع	جزئیات
appId	string	شناسه برنامه (شناسه پکیج برای اندروید، شناسه باندل برای iOS)
options اختیاری	object	گزینه‌های دستور. مثلاً "timeout": (فقط اندروید) مهلت برای تلاش مجدد خاتمه دادن برنامه (برای اطلاعات بیشتر به مستندات Appium مراجعه کنید)

پشتیبانی

---

isAppInstalled

بررسی اینکه آیا برنامه مشخص شده روی دستگاه نصب شده است یا خیر.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.isAppInstalled(appId)

پارامترها

نام	نوع	جزئیات
appId	string	شناسه برنامه (شناسه پکیج برای اندروید، شناسه باندل برای iOS)

خروجی‌ها

• <boolean> isAppInstalled: اگر نصب شده باشد true و در غیر این صورت false برمی‌گرداند

پشتیبانی

---

queryAppState

دریافت وضعیت برنامه مشخص شده روی دستگاه

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.queryAppState(appId)

پارامترها

نام	نوع	جزئیات
appId	string	شناسه برنامه (شناسه پکیج برای اندروید، شناسه باندل برای iOS)

خروجی‌ها

• <number> appStatus: 0 یعنی نصب نشده است. 1 یعنی در حال اجرا نیست. 2 یعنی در پس‌زمینه یا به حالت تعلیق در آمده است. 3 یعنی در پس‌زمینه در حال اجراست. 4 یعنی در پیش‌زمینه در حال اجراست

پشتیبانی

---

hideKeyboard

مخفی کردن صفحه کلید نرم.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.hideKeyboard(strategy, key, keyCode, keyName)

پارامترها

نام	نوع	جزئیات
strategy اختیاری	string	استراتژی مخفی کردن صفحه کلید (فقط UIAutomation)، استراتژی‌های در دسترس - 'press'، 'pressKey'، 'swipeDown'، 'tapOut'، 'tapOutside'، 'default'
key اختیاری	string	مقدار کلید اگر استراتژی 'pressKey' باشد
keyCode اختیاری	string	کد کلید اگر استراتژی 'pressKey' باشد
keyName اختیاری	string	نام کلید اگر استراتژی 'pressKey' باشد

پشتیبانی

---

isKeyboardShown

آیا صفحه کلید نرم نمایش داده می‌شود یا خیر.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.isKeyboardShown()

خروجی‌ها

• <boolean> isKeyboardShown: اگر صفحه کلید نمایش داده شود، True

پشتیبانی

---

pushFile

قرار دادن یک فایل روی دستگاه در مکان خاص.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.pushFile(path, data)

پارامترها

نام	نوع	جزئیات
path	string	مسیری که داده در آن نصب می‌شود
data	string	محتوای فایل به صورت base64

پشتیبانی

---

pullFile

بازیابی یک فایل از سیستم فایل دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.pullFile(path)

پارامترها

نام	نوع	جزئیات
path	string	مسیر فایل روی دستگاه

خروجی‌ها

• <string> response: محتوای فایل به صورت base64

پشتیبانی

---

pullFolder

بازیابی یک پوشه از سیستم فایل دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.pullFolder(path)

پارامترها

نام	نوع	جزئیات
path	string	مسیر به یک پوشه کامل روی دستگاه

پشتیبانی

---

toggleAirplaneMode

تغییر وضعیت حالت هواپیما روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.toggleAirplaneMode()

پشتیبانی

---

toggleData

تغییر وضعیت سرویس داده.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.toggleData()

پشتیبانی

---

toggleWiFi

تغییر وضعیت سرویس WiFi.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.toggleWiFi()

پشتیبانی

---

toggleLocationServices

تغییر وضعیت سرویس موقعیت‌یابی.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.toggleLocationServices()

پشتیبانی

---

toggleNetworkSpeed

تنظیم سرعت شبکه (فقط شبیه‌ساز)

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.toggleNetworkSpeed(netspeed)

پارامترها

نام	نوع	جزئیات
netspeed	string	نوع شبکه - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

پشتیبانی

---

openNotifications

باز کردن اعلانات اندروید (فقط شبیه‌ساز).

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.openNotifications()

پشتیبانی

---

startActivity

شروع یک فعالیت اندروید با ارائه نام پکیج و نام فعالیت.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.startActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset)

پارامترها

نام	نوع	جزئیات
appPackage	string	نام برنامه
appActivity	string	نام فعالیت
appWaitPackage اختیاری	string	نام برنامه برای انتظار
appWaitActivity اختیاری	string	نام فعالیت برای انتظار
intentAction=android.intent.action.MAIN اختیاری	string	intent action که برای شروع فعالیت استفاده می‌شود
intentCategory=android.intent.category.LAUNCHER اختیاری	string	دسته intent که برای شروع فعالیت استفاده می‌شود
intentFlags=0x10200000 اختیاری	string	پرچم‌هایی که برای شروع فعالیت استفاده می‌شوند
optionalIntentArguments اختیاری	string	آرگومان‌های intent اضافی که برای شروع فعالیت استفاده می‌شوند
dontStopAppOnReset اختیاری	string	قبل از شروع برنامه با استفاده از adb، فرآیند برنامه تحت آزمایش را متوقف نمی‌کند

پشتیبانی

---

getSystemBars

بازیابی اطلاعات نمایش و محدوده نوارهای وضعیت و ناوبری.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getSystemBars()

خروجی‌ها

• <object[]> systemBars: اطلاعات درباره نمایش و محدوده نوارهای وضعیت و ناوبری

پشتیبانی

---

getDeviceTime

دریافت زمان روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getDeviceTime()

خروجی‌ها

• <string> time: زمان روی دستگاه

پشتیبانی

---

getDisplayDensity

دریافت تراکم نمایش از دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getDisplayDensity()

خروجی‌ها

• <*>

پشتیبانی

---

touchId

شبیه‌سازی یک رویداد touch id (فقط شبیه‌ساز iOS). برای فعال‌سازی این ویژگی، ویژگی موردنیاز allowTouchIdEnroll باید روی true تنظیم شود و شبیه‌ساز باید ثبت نام شده باشد. وقتی allowTouchIdEnroll را روی true تنظیم می‌کنید، به طور پیش‌فرض شبیه‌ساز را ثبت خواهد کرد. وضعیت ثبت نام را می‌توان تغییر داد. این فراخوانی فقط زمانی کار می‌کند که فرآیند Appium یا برنامه والد آن (مثلاً Terminal.app یا Appium.app) به دسترسی سیستم عامل Mac در System Preferences > Security & Privacy > Privacy > Accessibility دسترسی داشته باشد.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.touchId(match)

پارامترها

نام	نوع	جزئیات
match	boolean	آیا ما یک لمس موفق را شبیه‌سازی می‌کنیم (true) یا یک لمس ناموفق (false)

پشتیبانی

---

toggleEnrollTouchId

تغییر وضعیت شبیه‌ساز برای ثبت نام و پذیرش touchId (فقط شبیه‌ساز iOS). برای فعال‌سازی این ویژگی، ویژگی موردنیاز allowTouchIdEnroll باید روی true تنظیم شود. وقتی allowTouchIdEnroll روی true تنظیم شود، شبیه‌ساز به طور پیش‌فرض ثبت نام خواهد شد، و 'Toggle Touch ID Enrollment' وضعیت ثبت نام را تغییر می‌دهد. این فراخوانی فقط زمانی کار می‌کند که فرآیند Appium یا برنامه والد آن (مثلاً Terminal.app یا Appium.app) به دسترسی سیستم عامل Mac در System Preferences > Security & Privacy > Privacy > Accessibility دسترسی داشته باشد.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.toggleEnrollTouchId(enabled)

پارامترها

نام	نوع	جزئیات
enabled=true اختیاری	boolean	اگر ثبت نام TouchID باید فعال شود، برابر با true است

پشتیبانی

---

launchApp

راه‌اندازی یک برنامه روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

احتیاط

این دستور پروتکل منسوخ شده است
برای iOS، از driver.execute('mobile: launchApp', { ... }) استفاده کنید، و برای اندروید، از driver.execute('mobile: activateApp', { ... }) استفاده کنید.

استفاده

driver.launchApp()

پشتیبانی

---

closeApp

بستن یک برنامه روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

احتیاط

این دستور پروتکل منسوخ شده است
به جای آن از driver.execute('mobile: terminateApp', { ... }) استفاده کنید

استفاده

driver.closeApp()

پشتیبانی

---

background

ارسال برنامه در حال اجرای فعلی برای این جلسه به پس‌زمینه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

احتیاط

این دستور پروتکل منسوخ شده است
به جای آن از driver.execute('mobile: backgroundApp', { ... }) استفاده کنید

استفاده

driver.background(seconds)

پارامترها

نام	نوع	جزئیات
seconds=null	number, null	مهلت برای بازگرداندن برنامه، اگر 'null' باشد برنامه بازگردانده نمی‌شود

پشتیبانی

---

endCoverage

دریافت داده‌های پوشش آزمون.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.endCoverage(intent, path)

پارامترها

نام	نوع	جزئیات
intent	string	intent برای پخش
path	string	مسیر به فایل .ec

پشتیبانی

---

getStrings

دریافت رشته‌های برنامه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getStrings(language, stringFile)

پارامترها

نام	نوع	جزئیات
language اختیاری	string	کد زبان
stringFile اختیاری	string	مسیر به فایل رشته

خروجی‌ها

• <object> appStrings: تمام رشته‌های تعریف شده از یک برنامه برای زبان و نام فایل رشته‌های مشخص شده

پشتیبانی

---

setValueImmediate

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.setValueImmediate(elementId, text)

پارامترها

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

پشتیبانی

---

replaceValue

جایگزینی مقدار با عنصر به طور مستقیم.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.replaceValue(elementId, value)

پارامترها

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

پشتیبانی

---

getSettings

بازیابی تنظیمات فعلی روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getSettings()

خروجی‌ها

• <object> settings: هش JSON از تمام تنظیمات مشخص شده فعلی، به API تنظیمات مراجعه کنید

پشتیبانی

---

updateSettings

به‌روزرسانی تنظیمات فعلی روی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.updateSettings(settings)

پارامترها

نام	نوع	جزئیات
settings	object	شیء key/value با تنظیماتی که باید به‌روزرسانی شوند

پشتیبانی

---

receiveAsyncResponse

URL کال‌بک برای اجرای ناهمگام JavaScript.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.receiveAsyncResponse(response)

پارامترها

نام	نوع	جزئیات
response	object	پاسخی که روی دستگاه دریافت می‌شود

پشتیبانی

---

gsmCall

برقراری تماس GSM (فقط شبیه‌ساز).

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.gsmCall(phoneNumber, action)

پارامترها

نام	نوع	جزئیات
phoneNumber	string	شماره تلفنی که می‌خواهید با آن تماس بگیرید
action	string	عمل - 'call'، 'accept'، 'cancel'، 'hold'

پشتیبانی

---

gsmSignal

تنظیم قدرت سیگنال GSM (فقط شبیه‌ساز).

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.gsmSignal(signalStrength, signalStrengh)

پارامترها

نام	نوع	جزئیات
signalStrength	string	قدرت سیگنال در محدوده [0، 4]
signalStrengh اختیاری	string	قدرت سیگنال در محدوده [0، 4]. لطفاً اگر از Appium نسخه v1.11.0 یا پایین‌تر استفاده می‌کنید، این پارامتر را نیز با همان مقدار تنظیم کنید (به https://github.com/appium/appium/issues/12234 مراجعه کنید).

پشتیبانی

---

powerCapacity

تنظیم درصد باتری (فقط شبیه‌ساز).

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.powerCapacity(percent)

پارامترها

نام	نوع	جزئیات
percent	number	مقدار درصد در محدوده [0، 100]

پشتیبانی

---

powerAC

تنظیم وضعیت شارژر باتری به متصل یا غیرمتصل (فقط شبیه‌ساز).

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.powerAC(state)

پارامترها

نام	نوع	جزئیات
state	string	تنظیم وضعیت. on یا off

پشتیبانی

---

gsmVoice

تنظیم وضعیت صدای GSM (فقط شبیه‌ساز).

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.gsmVoice(state)

پارامترها

نام	نوع	جزئیات
state	string	وضعیت صدای GSM - 'unregistered'، 'home'، 'roaming'، 'searching'، 'denied'، 'off'، 'on'

پشتیبانی

---

sendSms

شبیه‌سازی یک پیام SMS (فقط شبیه‌ساز).

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.sendSms(phoneNumber, message)

پارامترها

نام	نوع	جزئیات
phoneNumber	string	شماره تلفنی که می‌خواهید SMS را به آن ارسال کنید
message	string	پیام SMS

پشتیبانی

---

fingerPrint

احراز هویت کاربران با استفاده از اسکن اثر انگشت آنها در شبیه‌سازهای پشتیبانی شده.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.fingerPrint(fingerprintId)

پارامترها

نام	نوع	جزئیات
fingerprintId	number	اثر انگشت‌های ذخیره شده در سیستم Keystore اندروید (از 1 تا 10)

پشتیبانی

---

setClipboard

تنظیم محتوای کلیپ‌بورد سیستم

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.setClipboard(content, contentType, label)

پارامترها

نام	نوع	جزئیات
content	string	محتوای واقعی کلیپ‌بورد کدگذاری شده با base64
contentType اختیاری	string	نوع محتوا برای دریافت. Plaintext، Image، URL. اندروید فقط از plaintext پشتیبانی می‌کند
label اختیاری	string	برچسب داده کلیپ‌بورد برای اندروید

خروجی‌ها

• <string> response: پاسخ از سرور Appium

پشتیبانی

---

getClipboard

دریافت محتوای کلیپ‌بورد سیستم

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getClipboard(contentType)

پارامترها

نام	نوع	جزئیات
contentType اختیاری	string	نوع محتوا برای دریافت. Plaintext، Image، URL. اندروید فقط از plaintext پشتیبانی می‌کند

خروجی‌ها

• <string> response: محتوای کلیپ‌بورد به صورت رشته کدگذاری شده با base64 یا یک رشته خالی اگر کلیپ‌بورد خالی باشد

پشتیبانی

---

touchPerform

این قابلیت فقط از درون یک context بومی در دسترس است. 'Touch Perform' مشابه سایر تعاملات لمسی تکی عمل می‌کند، با این تفاوت که این به شما اجازه می‌دهد بیش از یک عمل لمسی را به عنوان یک دستور زنجیر کنید. این مفید است زیرا دستورات Appium از طریق شبکه ارسال می‌شوند و بین دستورات تأخیر وجود دارد. این تأخیر می‌تواند برخی از تعاملات لمسی را غیرممکن سازد زیرا برخی از تعاملات نیاز به انجام در یک توالی دارند. برای مثال، حرکت عمودی نیاز به فشردن، حرکت به یک مختصات y متفاوت و سپس رها کردن دارد. برای اینکه کار کند، نمی‌تواند بین تعاملات تأخیر وجود داشته باشد.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.touchPerform(actions)

پارامترها

نام	نوع	جزئیات
actions	object[]	نوع عملی که باید انجام شود (مانند moveTo، release، press، tap، wait)

مثال

// انجام یک swipe افقی با درصد
const startPercentage = 10;
const endPercentage = 90;
const anchorPercentage = 50;

const { width, height } = driver.getWindowSize();
const anchor = height * anchorPercentage / 100;
const startPoint = width * startPercentage / 100;
const endPoint = width * endPercentage / 100;
driver.touchPerform([
  {
    action: 'press',
    options: {
      x: startPoint,
      y: anchor,
    },
  },
  {
    action: 'wait',
    options: {
      ms: 100,
    },
  },
  {
    action: 'moveTo',
    options: {
      x: endPoint,
      y: anchor,
    },
  },
  {
    action: 'release',
    options: {},
  },
]);

پشتیبانی

---

multiTouchPerform

این قابلیت فقط از درون یک context بومی در دسترس است. انجام یک توالی عمل لمسی چندگانه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.multiTouchPerform(actions)

پارامترها

نام	نوع	جزئیات
actions	object[]	نوع عملی که باید انجام شود (مانند moveTo، release، press، tap، wait)

پشتیبانی

---

executeDriverScript

این دستور به شما امکان می‌دهد یک اسکریپت WebdriverIO را به صورت یک رشته مشخص کنید و آن را به سرور Appium برای اجرای محلی در خود سرور ارسال کنید. این رویکرد به کاهش تأخیر احتمالی مرتبط با هر دستور کمک می‌کند. برای استفاده از این دستور با Appium 2.0، باید افزونه execute-driver-plugin را نصب کرده باشید.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.executeDriverScript(script, type, timeout)

پارامترها

نام	نوع	جزئیات
script	string	اسکریپتی که باید اجرا شود. دسترسی به یک شیء 'driver' دارد که یک جلسه WebdriverIO متصل به سرور فعلی را نشان می‌دهد.
type اختیاری	string	زبان/چارچوب استفاده شده در اسکریپت. در حال حاضر، فقط 'webdriverio' پشتیبانی می‌شود و پیش‌فرض است.
timeout اختیاری	number	تعداد میلی‌ثانیه‌ای که اسکریپت باید قبل از کشته شدن توسط سرور Appium اجازه اجرا داشته باشد. به طور پیش‌فرض معادل 1 ساعت است.

خروجی‌ها

• <object> result: یک شیء شامل دو فیلد: 'result'، که مقدار بازگشتی خود اسکریپت است، و 'logs'، که شامل 3 فیلد داخلی 'log'، 'warn' و 'error' است که آرایه‌ای از رشته‌هایی هستند که توسط console.log، console.warn و console.error در اجرای اسکریپت ثبت شده‌اند.

---

getEvents

دریافت رویدادهای ذخیره شده در سرور appium.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getEvents(type)

پارامترها

نام	نوع	جزئیات
type	string[]	دریافت رویدادهایی که با نوع فیلتر شده‌اند اگر نوع ارائه شده باشد.

خروجی‌ها

• <object> result: یک هش JSON از رویدادها مانند {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.

پشتیبانی

---

logEvent

ذخیره یک رویداد سفارشی.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.logEvent(vendor, event)

پارامترها

نام	نوع	جزئیات
vendor	string	نام فروشنده. در vendor:event به صورت vendor خواهد بود.
event	string	نام رویداد. در vendor:event به صورت event خواهد بود.

پشتیبانی

---

compareImages

این ویژگی مقایسه‌های تصویری را با استفاده از قابلیت‌های چارچوب OpenCV انجام می‌دهد. لطفاً توجه داشته باشید که برای کار کردن این قابلیت، هم چارچوب OpenCV و هم ماژول opencv4nodejs باید روی ماشینی که سرور Appium در آن فعال است نصب شوند. علاوه بر این، برای استفاده از این ویژگی با Appium 2.0، نیاز به نصب افزونه images-plugin دارید.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.compareImages(mode, firstImage, secondImage, options)

پارامترها

نام	نوع	جزئیات
mode=matchFeatures	string	یکی از حالت‌های مقایسه ممکن: 'matchFeatures'، 'getSimilarity'، 'matchTemplate'. 'matchFeatures' به طور پیش‌فرض است.
firstImage	string	داده تصویر. همه فرمت‌های تصویری که خود کتابخانه OpenCV می‌پذیرد، پشتیبانی می‌شوند.
secondImage	string	داده تصویر. همه فرمت‌های تصویری که خود کتابخانه OpenCV می‌پذیرد، پشتیبانی می‌شوند.
options=[object Object]	object	محتوای این دیکشنری به مقدار واقعی mode بستگی دارد. برای جزئیات بیشتر به مستندات ماژول appium-support مراجعه کنید.

خروجی‌ها

• <object> result: محتوای دیکشنری نتیجه به مقادیر واقعی mode و options بستگی دارد. برای جزئیات بیشتر به مستندات ماژول appium-support مراجعه کنید.

---

implicitWait

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

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.implicitWait(ms)

پارامترها

نام	نوع	جزئیات
ms	number	مدت زمانی، به میلی‌ثانیه، برای انتظار روی یک عنصر.

پشتیبانی

---

getLocationInView

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

نکته: این به عنوان یک دستور داخلی در نظر گرفته می‌شود و باید فقط برای تعیین موقعیت یک عنصر برای تولید صحیح رویدادهای بومی استفاده شود.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getLocationInView(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه عنصری که دستور به آن مسیردهی می‌شود

خروجی‌ها

• <Object> location: مختصات X و Y برای عنصر در صفحه.

پشتیبانی

---

sendKeys

ارسال یک توالی از ضربات کلید به عنصر فعال

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.sendKeys(value)

پارامترها

نام	نوع	جزئیات
value	string[]	توالی کلیدهایی که باید تایپ شوند. باید یک آرایه ارائه شود.

پشتیبانی

---

availableIMEEngines

لیست تمام موتورهای موجود روی دستگاه. برای استفاده از یک موتور، باید در این لیست موجود باشد.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.availableIMEEngines()

خروجی‌ها

• <String[]> engines: لیست موتورهای در دسترس

پشتیبانی

---

getActiveIMEEngine

دریافت نام موتور IME فعال. رشته نام بستگی به پلتفرم دارد.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getActiveIMEEngine()

خروجی‌ها

• <String> engine: نام موتور IME فعال

پشتیبانی

---

isIMEActivated

نشان می‌دهد که آیا ورودی IME در حال حاضر فعال است یا خیر

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.isIMEActivated()

خروجی‌ها

• <Boolean> isActive: اگر ورودی IME در دسترس و در حال حاضر فعال است true، در غیر این صورت false

پشتیبانی

---

deactivateIMEEngine

غیرفعال کردن موتور IME فعال فعلی.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.deactivateIMEEngine()

پشتیبانی

---

activateIMEEngine

فعال کردن موتوری که در دسترس است

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.activateIMEEngine(engine)

پارامترها

نام	نوع	جزئیات
engine	string	نام موتور برای فعال‌سازی

پشتیبانی

---

asyncScriptTimeout

تنظیم مدت زمان، به میلی‌ثانیه، که اسکریپت‌های ناهمگام اجرا شده توسط /session/:sessionId/execute_async مجاز به اجرا هستند قبل از اینکه قطع شوند و یک خطای Timeout به کلاینت برگردانده شود.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.asyncScriptTimeout(ms)

پارامترها

نام	نوع	جزئیات
ms	number	مدت زمان، به میلی‌ثانیه، که دستورات محدود به زمان مجاز به اجرا هستند

پشتیبانی

---

submit

ارسال یک عنصر فرم.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.submit(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه عنصر فرمی که باید ارسال شود

پشتیبانی

---

getElementSize

تعیین اندازه یک عنصر به پیکسل. اندازه به صورت یک شیء JSON با ویژگی‌های width و height برگردانده می‌شود.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getElementSize(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه عنصری که دستور به آن مسیردهی می‌شود

خروجی‌ها

• <Object> size: عرض و ارتفاع عنصر، به پیکسل.

پشتیبانی

---

getElementLocation

تعیین موقعیت یک عنصر در صفحه. نقطه (0, 0) به گوشه بالا سمت چپ صفحه اشاره دارد. مختصات عنصر به صورت یک شیء JSON با ویژگی‌های x و y برگردانده می‌شود.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getElementLocation(elementId)

پارامترها

نام	نوع	جزئیات
elementId	String	شناسه عنصری که دستور به آن مسیردهی می‌شود

خروجی‌ها

• <Object> location: مختصات X و Y برای عنصر در صفحه.

پشتیبانی

---

touchClick

تک ضربه روی دستگاه لمسی.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.touchClick(element)

پارامترها

نام	نوع	جزئیات
element	string	شناسه عنصری که باید روی آن تک ضربه زد.

پشتیبانی

---

touchDown

انگشت پایین روی صفحه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.touchDown(x, y)

پارامترها

نام	نوع	جزئیات
x	number	مختصات x روی صفحه
y	number	مختصات y روی صفحه

پشتیبانی

---

touchUp

انگشت بالا روی صفحه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.touchUp(x, y)

پارامترها

نام	نوع	جزئیات
x	number	مختصات x روی صفحه
y	number	مختصات y روی صفحه

پشتیبانی

---

touchMove

حرکت انگشت روی صفحه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.touchMove(x, y)

پارامترها

نام	نوع	جزئیات
x	number	مختصات x روی صفحه
y	number	مختصات y روی صفحه

پشتیبانی

---

touchLongClick

فشار طولانی روی صفحه لمسی با استفاده از رویدادهای حرکت انگشت.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.touchLongClick(element)

پارامترها

نام	نوع	جزئیات
element	string	شناسه عنصری که باید روی آن فشار طولانی اعمال کرد

پشتیبانی

---

touchFlick

ضربه سریع روی صفحه لمسی با استفاده از رویدادهای حرکت انگشت. این دستور ضربه سریع از یک مکان خاص صفحه شروع می‌شود.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.touchFlick(xoffset, yoffset, element, speed, xspeed, yspeed)

پارامترها

نام	نوع	جزئیات
xoffset اختیاری	number	آفست x به پیکسل برای ضربه زدن
yoffset اختیاری	number	آفست y به پیکسل برای ضربه زدن
element اختیاری	string	شناسه عنصری که ضربه سریع از آنجا شروع می‌شود
speed اختیاری	number	سرعت به پیکسل در ثانیه
xspeed اختیاری	number	سرعت x به پیکسل در ثانیه
yspeed اختیاری	number	سرعت y به پیکسل در ثانیه

پشتیبانی

---

getOrientation

دریافت جهت فعلی دستگاه.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getOrientation()

خروجی‌ها

• <String> orientation: جهت فعلی مطابق با مقدار تعریف شده در ScreenOrientation: LANDSCAPE|PORTRAIT.

پشتیبانی

---

setOrientation

تنظیم جهت دستگاه

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.setOrientation(orientation)

پارامترها

نام	نوع	جزئیات
orientation	string	جهت جدید مرورگر به صورت تعریف شده در ScreenOrientation: LANDSCAPE|PORTRAIT

پشتیبانی

---

getLogs

دریافت گزارش برای یک نوع گزارش مشخص. بافر گزارش پس از هر درخواست بازنشانی می‌شود.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getLogs(type)

پارامترها

نام	نوع	جزئیات
type	string	نوع گزارش

خروجی‌ها

• <Object[]> logs: لیست ورودی‌های گزارش.

پشتیبانی

---

getLogTypes

دریافت انواع گزارش‌های در دسترس.

دستور Appium. جزئیات بیشتر را می‌توانید در مستندات رسمی پروتکل پیدا کنید.

استفاده

driver.getLogTypes()

خروجی‌ها

• <String[]> logTypes: لیست انواع گزارش‌های در دسترس.

پشتیبانی