mobilesession

この記事の内容
  1. xbot.mobile.session
  2. メソッド
  3. find_all()
  4. find()
  5. find_all_by_id()
  6. find_by_id()
  7. find_all_by_accessibility_id()
  8. find_by_accessibility_id()
  9. find_all_by_label_name()
  10. find_by_label_name()
  11. find_all_by_xpath()
  12. find_by_xpath()
  13. find_all_by_uiautomator_selector()
  14. find_by_uiautomator_selector()
  15. contains_element()
  16. click()
  17. dblclick()
  18. longpress()
  19. swipe()
  20. back()
  21. home()
  22. switchapp()
  23. getoriention()
  24. setoriention()
  25. screenshot()
  26. get_page_source()
  27. get_clipboard_text()
  28. set_clipboard_text()
  29. get_session_detail()
  30. close()

xbot.mobile.session

sessionインターフェースは、主に要素の検索やデバイス操作など、スマホ接続に関する操作を行います。

以下の例にある ANDROID_DEVICE_NAME は、Dr.Roboに登録したスマホのカスタム名に置き換えてください。ITEM_LABEL と INPUT_FIELD は、実際にキャプチャして要素ライブラリへ保存した要素名に置き換えます。com.example.app は中立的なアプリパッケージ名の例です。resource-id、XPath、accessibility_id、クラス名などのセレクターは、対象アプリの実際の値に合わせてください。これらの例をそのまま使用しても、対象のスマホや要素は特定できません。

メソッド

find_all()

スマホ内でセレクターに一致するすべての要素を取得し、要素リストを返します。

find_all(self, selector)

入力パラメータ

selector:検索するセレクターです。str型(要素ライブラリ内の要素を検索)とSelector型(フロー内ですでに取得したスマホの要素オブジェクト)の2つの形式をサポートします。

戻り値

List[MobileElement]:スマホの要素リストです。

例1

import xbot
from xbot import print, sleep
from . import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    elements = session.find_all('ITEM_LABEL')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でセレクター「ITEM_LABEL」に一致するすべての要素を検索し、要素リストを返します。

find()

スマホ内で要素セレクターに一致する要素を取得します。

find(self, selector)

入力パラメータ

selector:検索するセレクターです。str型(要素ライブラリ内の要素を検索)とSelector型(フロー内ですでに取得したスマホの要素オブジェクト)の2つの形式をサポートします。

戻り値

MobileElement:スマホの要素です。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    element = session.find('ITEM_LABEL')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でセレクター「ITEM_LABEL」に一致する要素を検索して返します。

find_all_by_id()

スマホ内で指定したresource-idを持つすべての要素を取得し、要素リストを返します。

find_all_by_id(self, id)

入力パラメータ

id:要素のresource-id属性値です。

戻り値

List[MobileElement]:スマホの要素リストです。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    elements = session.find_all_by_id('com.example.app:id/item_label')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でid com.example.app:id/item_label を使用し、一致するすべての類似要素リストを検索します。

find_by_id()

スマホ内で指定したresource-idを持つ要素を取得します。

find_by_id(self, id)

入力パラメータ

id:要素のresource-id属性値です。

戻り値

MobileElement:スマホの要素です。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    element = session.find_by_id('com.example.app:id/input_field')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でid com.example.app:id/input_field を使用し、一致するスマホの要素を検索します。

find_all_by_accessibility_id()

スマホ内で指定したaccessibility_idを持つすべての要素を取得し、要素リストを返します。

find_all_by_accessibility_id(self, accessibility_id)

入力パラメータ

accessibility_id:要素のcontent-desc属性値です。

戻り値

List[MobileElement]:スマホの要素リストです。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    elements = session.find_all_by_accessibility_id('icon')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でaccessibility_id 'icon' を使用し、一致する類似要素リストを検索します。

find_by_accessibility_id()

スマホ内で指定したaccessibility_idを持つ要素を取得します。

find_by_accessibility_id(self, accessibility_id)

入力パラメータ

accessibility_id:要素のcontent-desc属性値です。

戻り値

MobileElement:スマホの要素です。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    element = session.find_by_accessibility_id('icon')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でaccessibility_id 'icon' を使用し、一致するスマホの要素を検索します。

find_all_by_label_name()

スマホ内で指定したlabel_nameを持つすべての要素を取得し、要素リストを返します。

find_all_by_label_name(self, label_name)

入力パラメータ

label_name:要素のclass属性値/要素のタグ名です。

戻り値

List[MobileElement]:スマホの要素リストです。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    elements = session.find_all_by_label_name('android.widget.TextView')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でlabel_name 'android.widget.TextView' を使用し、一致する類似要素リストを検索します。

find_by_label_name()

スマホ内で指定したlabel_nameを持つ要素を取得します。

find_by_label_name(self, label_name)

入力パラメータ

label_name:要素のclass属性値/要素のタグ名です。

戻り値

MobileElement:スマホの要素です。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    element = session.find_by_label_name('android.widget.TextView')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でlabel_name 'android.widget.TextView' を使用し、一致するスマホの要素を検索します。

find_all_by_xpath()

スマホ内で指定したxpathに一致するすべての要素を取得し、要素リストを返します。

find_all_by_xpath(self, xpath)

入力パラメータ

xpath:要素のxpathパスです。

戻り値

List[MobileElement]:スマホの要素リストです。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    elements = session.find_all_by_xpath('/hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.FrameLayout/android.widget.FrameLayout/android.widget.TabHost/android.widget.FrameLayout/android.widget.FrameLayout/android.widget.TabWidget/android.widget.FrameLayout[1]/android.widget.RelativeLayout/android.widget.TextView')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でxpathを使用し、一致するすべての類似要素リストを検索します。

find_by_xpath()

スマホ内で指定したxpathに一致する要素を取得します。

find_by_xpath(self, xpath)

入力パラメータ

xpath:要素のxpathパスです。

戻り値

MobileElement:スマホの要素です。

例1

import xbot
from xbot import print, sleep
from . import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    element = session.find_by_xpath('/hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.FrameLayout/android.widget.FrameLayout/android.widget.TabHost/android.widget.FrameLayout/android.widget.FrameLayout/android.widget.TabWidget/android.widget.FrameLayout[1]/android.widget.RelativeLayout/android.widget.TextView')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でxpathを使用し、一致するスマホの要素を検索します。

find_all_by_uiautomator_selector()

スマホ内で指定したuiautomator_selectorに一致するすべての要素を取得し、要素リストを返します。

find_all_by_uiautomator_selector(self, uiautomator_selector)

入力パラメータ

uiautomator_selector:要素のAndroidセレクターパスです。

戻り値

List[MobileElement]:スマホの要素リストです。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    elements = session.find_all_by_uiautomator_selector('new UiSelector().className(\"android.widget.ImageView\")')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でuiautomator_selectorを使用し、一致する類似要素リストを検索します。

find_by_uiautomator_selector()

スマホ内で指定したuiautomator_selectorに一致する要素を取得します。

find_by_uiautomator_selector(self, uiautomator_selector)

入力パラメータ

uiautomator_selector:要素のAndroidセレクターパスです。

戻り値

MobileElement:スマホの要素です。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    element = session.find_by_uiautomator_selector('new UiSelector().className(\"android.widget.ImageView\")')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内でuiautomator_selectorを使用し、一致するスマホの要素を検索します。

contains_element()

現在のスマホ内に要素セレクターに一致する要素が含まれているかどうかを確認します。

contains_element(self, selector)

入力パラメータ

selector:検索するセレクターです。str型(要素ライブラリ内の要素を検索)とSelector型(フロー内ですでに取得したスマホの要素オブジェクト)の2つの形式をサポートします。

戻り値

bool:スマホに対象要素が含まれている場合はTrueを返し、それ以外の場合はFalseを返します。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    if session.contains_element('INPUT_FIELD') == True:
        print('要素が存在します')
    else:
        print('要素が存在しません')

この例の実行ロジック: 指定されたスマホに接続します --> 現在のスマホ内に「INPUT_FIELD」という名前の要素が含まれているかどうかを判定します --> 判定結果に応じた内容を出力します。

click()

スマホの画面指定位置をクリックします。

click(self, point_x, point_y, delay_after=1)

入力パラメータ

point_x:対象点の横方向の座標です。

point_y:対象点の縦方向の座標です。

delay_after:実行成功後の待機時間です。デフォルトでは1秒待機します。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.click(500, 500)

この例の実行ロジック: 指定されたスマホに接続します --> 画面の (500, 500) の位置をクリックします。

dblclick()

スマホの画面指定位置をダブルクリックします。

dblclick(self, point_x, point_y, delay_after=1)

入力パラメータ

point_x:対象点の横方向の座標です。

point_y:対象点の縦方向の座標です。

delay_after:実行成功後の待機時間です。デフォルトでは1秒待機します。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.dblclick(500, 500)

この例の実行ロジック: 指定されたスマホに接続します --> 画面の (500, 500) の位置をダブルクリックします。

longpress()

スマホの画面指定位置を長押しします。

dblclick(self, point_x, point_y, delay_after=1)

入力パラメータ

point_x:対象点の横方向の座標です。

point_y:対象点の縦方向の座標です。

delay_after:実行成功後の待機時間です。デフォルトでは1秒待機します。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.longpress(500, 500)

この例の実行ロジック: 指定されたスマホに接続します --> 画面の (500, 500) の位置を長押しします。

swipe()

スマホの画面上で指をスワイプします。

swipe(self, start_point_x, start_point_y, end_point_x, end_point_y, swipe_time=800, delay_after=1)

入力パラメータ

start_point_x:スワイプ開始点の横方向の座標です。

start_point_y:スワイプ開始点の縦方向の座標です。

end_point_x:スワイプ終了点の横方向の座標です。

end_point_y:スワイプ終了点の縦方向の座標です。

swipe_time:スワイプの合計時間です。

delay_after:実行成功後の待機時間です。デフォルトでは1秒待機します。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.swipe(500, 1200, 500, 200)

この例の実行ロジック: 指定されたスマホに接続します --> 画面上で指を上にスワイプする操作をシミュレートします。

back()

戻る

back(self, delay_after=1)

入力パラメータ

delay_after:実行成功後の待機時間です。デフォルトでは1秒待機します。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from . import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.back()

この例の実行ロジック: 指定されたスマホに接続します --> スマホの戻るキーの押下をシミュレートします。

home()

ホーム

home(self, delay_after=1)

入力パラメータ

delay_after:実行成功後の待機時間です。デフォルトでは1秒待機します。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.home()

この例の実行ロジック: 指定されたスマホに接続します --> スマホのホームキーの押下をシミュレートします。

switchapp()

アプリ切り替え

switchapp(self, delay_after=1)

入力パラメータ

delay_after:実行成功後の待機時間です。デフォルトでは1秒待機します。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.switchapp()

この例の実行ロジック: 指定されたスマホに接続します --> スマホのアプリ切り替えをシミュレートします。

getoriention()

スマホの現在の画面方向を取得します。

getoriention(self)

入力パラメータ

なし

戻り値

int:横向きの場合は0、縦向きの場合は1を返します。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    orientation_code=session.getoriention()
    print(orientation_code)

この例の実行ロジック: 指定されたスマホに接続します --> スマホの現在の画面方向を取得します --> 画面方向のコードを出力します。

setoriention()

スマホの画面方向を設定します。

setoriention(self, screenOrientation:int)

入力パラメータ

screenOrientation:横向きは0、縦向きは1です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from . import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.setoriention(0)

この例の実行ロジック: 指定されたスマホに接続します --> スマホの現在の画面方向を横向きに設定します。

screenshot()

スマホ画面のスクリーンショットを撮影して保存します。

screenshot(self, folder_path, filename=None)

入力パラメータ

folder_path:スクリーンショットの保存先パスです。

filename:スクリーンショットを保存する際のファイル名です。空にすることができ、空の場合は現在時刻に基づいてファイル名を自動生成します。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.screenshot('D:\\')

この例の実行ロジック: 指定されたスマホに接続します --> スマホ画面のスクリーンショットを撮影し、結果をDドライブのルートディレクトリに保存します。ファイル名は現在時刻に基づいて自動生成されます。

get_page_source()

スマホの現在のページのツリー構造情報を取得し、XML構造の文字列を返します。

get_page_source(self)

入力パラメータ

なし

戻り値

取得したUIツリーです。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    page_source = session.get_page_source()

この例の実行ロジック: 指定されたスマホに接続します --> スマホの現在のページのツリー構造情報を取得します。

get_clipboard_text()

クリップボードのテキスト内容を取得します。

get_clipboard_text(self)

入力パラメータ

なし

戻り値

str:テキスト内容を返します。

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    text = session.get_clipboard_text()
    print(text)

この例の実行ロジック: 指定されたスマホに接続します --> スマホのクリップボードの内容を取得します --> クリップボードの内容を出力します。

set_clipboard_text()

クリップボードのテキスト内容を設定します。

set_clipboard_text(self, value)

入力パラメータ

value:テキスト内容です。

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.set_clipboard_text('helloDr.Robo')

この例の実行ロジック: 指定されたスマホに接続します --> クリップボードの内容を 'helloDr.Robo' に設定します。

get_session_detail()

スマホの接続情報の詳細を取得します。

get_session_detail(self)

入力パラメータ

なし

戻り値

dict:接続情報の詳細を辞書として返します。

close()

このスマホとの接続を閉じます。

close(self)

入力パラメータ

なし

戻り値

なし

例1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    session = xbot.mobile.connect_by_custom_name('ANDROID_DEVICE_NAME')
    session.close()

この例の実行ロジック: 指定されたスマホに接続します --> スマホとの接続を閉じます。

APIリファレンスの記事一覧ページの先頭へ ↑