API

API を使用すると、[パッケージを管理] メニューで提供されているサービスにアクセスして操作することができます。これらの API は、コード化されたオートメーションを設計する際に使用できます。コード化されたオートメーションと、API を使用してそれらのオートメーションを設計する方法について詳しくは、こちらをご覧ください。

注: [定義に移動] (F12) を使用すると、特定のサービスの UiPath API の定義にアクセスできます。コード化されたオートメーションを実装する場合は、直接公開されている API のみを使用することをお勧めします。サービスで直接公開されていないその他の API は、事前の通知なしに変更される場合があります。

オーバー ロード

API には多くの場合、過剰な負荷があります。つまり、パラメーター オプションが異なる同じメソッドの複数のバージョンを提供します。 オーバー ロードすると、特定の要件に基づいて API の動作をカスタマイズできます。 たとえば、UI Automation API には、UI 要素が表示されるまでの最大時間を指定するタイムアウト パラメーターを受け入れるオーバー ロードが設定されている場合があります。

API をそれぞれのオーバー ロードで使用することで、目的のオートメーションのロジックと動作を簡単に実現できます。

モバイル オートメーション API

このセクションには、UiPath.MobileAutomation.API.Models サービスの API が含まれています。

API	説明
Dispose	オートメーションの実行中に使用されたリソースを解放し、これらのアクションによって占有されていたメモリをクリアして、Connection を元の状態に戻します。これにより、これらのリソースを Connection 上の他のタスクで利用できるようになります。
DrawPattern	デバイス画面上で、複数の点でマークされたパスを描画します。フィンガー パスの点は、デバイス画面上を指がなぞるルートから記録されます。複数のフィンガー パスを追加して、複数の指を使用する画面操作をシミュレートできます。
ElementExists	指定された UI 要素が存在するかどうかを示すブール変数を返します。
ExecuteCommand	特定のエンドポイントに関連付けられていないネイティブのモバイル コマンドを実行します。
Finalize	オブジェクトがクリーンアップ操作を実行し、ガベージ コレクションによって再利用される前にリソースを解放できるようにします。Object.Finalize メソッドを実装します。
属性を取得	指定した UI 要素の属性を取得します。
GetDeviceOrientation	指定したモバイル デバイスの現在の向きを取得します。
GetLogTypes	モバイル デバイスの Connection を介して接続されたデバイスから、ログの種類を取得します。
GetPageSource	Connection クラスを介して接続されたモバイル デバイスから、ページのソースを取得します。
GetSelectedItem	選択した項目を対象の UI 要素から取得します。
GetSessionIdentifier	現在のモバイル デバイス マネージャー接続のセッション ID を取得して、HTTP コマンドを Appium エンドポイントにルーティングし、カスタム アクションを実行できるようにします。
GetSystemTime	デバイスの現在の時刻を取得します。
GetText	指定した UI 要素からテキストを抽出し、String 変数として返します。
InstallApp	Connection で接続されたモバイル デバイスに、指定されたアプリをインストールします。
ManageCurrentApplication	このセッションの現在のアプリをリセットまたは起動します。
ManageOtherApplication	コマンドを使用して他のアプリケーションを管理します。
OpenDeepLink	アプリケーション内のディープ リンクを開きます。
OpenUrl	Chrome で URL を開きます。現在アクティブなアプリケーションはChrome で、このメソッドを呼び出す前に少なくとも 1 つのタブが開いている必要があります。
PositionalSwipe	開始位置と終了位置を指定して、画面のあらかじめ定義された場所までスワイプします。
PressHardwareButton	接続されたデバイス上のハードウェア ボタンを押します。
SaveLogs	特定の種類のログをファイルに保存します。
SetDeviceGeoLocation	デバイスの現在の地理的位置を設定します。
SetDeviceOrientation	接続したデバイスの向きを変更して、向きを取得します。
SetSelectedItem	選択した項目をターゲット要素上に設定します。
SetText	指定したテキストを、モバイル オートメーションによって認識されたターゲット UI 要素に入力します。
スワイプ	スワイプ操作は、指定した要素が見つかるまで、リスト上でスワイプを複数回反復処理します (MaxNumberOfSwipes を上限とする)。
スクリーンショットを作成	[高さ] および [幅] パラメーターで指定されたカスタム寸法を用いて使用しているモバイル デバイスの画面のスクリーンショットを撮ります。
タップ	指定した UI 要素が存在するかどうかを示す Boolean 変数を返します。API には戻り値はありませんが、指定した UI 要素が存在する場合 (Boolean 値)、タップ操作を実行します。
TypeText	キーボードで入力されたコンテンツを取得し、それを現在アクティブな UI 要素に貼り付けます。必要な要素の中にテキストを貼り付けるには、テキストを貼り付ける UI にフォーカスを当てる必要があります。この API は、キーボードでテキストを入力する必要があるにもかかわらず、モバイル オートメーションで認識できるターゲット要素がないアプリケーションを自動化する場合に使用できます。

API を使用する

対応するサービスから API を呼び出すには、 service.APIの形式を使用します。 たとえば、 system.GetAssetします。

モバイル オートメーション API を使用する

モバイル オートメーション API を使用するには、まずデバイスとアプリケーションへの接続を確立してから (詳しくは「接続」をご覧ください)、次にこの接続で必要なオートメーション メソッド (connection.Tap(<selector>); や var orientation = connection.GetDeviceOrientation();) を呼び出します。