预览

APIs

API 允许您访问“管理包”菜单中提供的服务并与之交互。 您可以在设计编码自动化时使用这些 API。 请访问编码自动化，了解编码自动化以及如何使用 API 进行设计。

注意：使用“转到定义”(F12) 允许您访问特定服务的 UiPath API 定义。我们建议在实施编码自动化时仅依赖直接公开的 API。未直接与服务一起公开的其他 API 如有更改，恕不另行通知。

重载

API 通常具有重载，这意味着它们为同一方法的多个版本提供不同的参数选项。重载允许您根据特定要求自定义 API 的行为。例如，用户界面自动化 API 可能具有接受超时参数的重载，以指定在结束执行之前等待用户界面元素出现的最长时间。

通过使用具有各自重载的 API，您可以轻松实现所需的自动化逻辑和行为。

移动自动化 API

本节包括 UiPath.MobileAutomation.API.Models 服务中的 API。

API	描述
Dispose	释放自动化期间使用的资源，清除这些操作占用的内存，并将Connection返回到其原始状态。 这使这些资源可用于Connection上的其他任务。
DrawPattern	在设备屏幕上绘制由多个点标记的路径。 根据手指在设备屏幕上的路径记录创建路径的点。 您可以添加多个手指路径，以模拟涉及多个手指的屏幕交互。
ElementExists	返回一个布尔值变量，用于声明指定的用户界面元素是否存在。
ExecuteCommand	执行未与特定端点关联的原生移动命令。
Finalize	使对象能够在垃圾收集器回收之前执行清理操作并释放资源。 实现Object.Finalize方法。
获取属性	检索指定用户界面元素的上级。
GetDeviceOrientation	检索指定移动设备的当前方向。
GetLogTypes	从通过移动设备Connection连接的设备中检索日志类型。
GetPageSource	从通过Connection类连接的移动设备检索页面源代码。
GetSelectedItem	从目标元素中获取选定的项目。
GetSessionIdentifier	检索当前移动设备管理器连接的会话 ID，以将 HTTP 命令路由到 Appium 端点，以便执行自定义 Actions。
GetSystemTime	检索设备的当前时间。
GetText	Extracts the text from a specified UI element and returns it as a String variable.
InstallApp	在通过Connection连接的移动设备上安装指定应用程序。
ManageCurrentApplication	重置或启动此会话的当前应用程序。
ManageOtherApplication	使用命令管理其他应用程序。
OpenDeepLink	打开应用程序中的深度链接。
OpenUrl	在 Chrome 中打开 URL。 在调用此方法之前，当前处于活动状态的应用程序应为 Chrome，并且至少已打开一个选项卡。
PositionalSwipe	滑动到屏幕上包含起点和终点的预定义位置。
PressHardwareButton	按下已连接设备上的硬件按钮
SaveLogs	将特定类型的日志保存至文件。
SetDeviceGeoLocation	设置设备的当前地理位置。
SetDeviceOrientation	更改并获取已连接设备的方向
SetSelectedItem	在目标元素上设置选定的项目。
SetText	在移动自动化可识别的目标用户界面元素中键入指定文本。
滑动	滑动操作会遍历列表中的多次滑动（直到达到MaxNumberOfSwiches 次数），直到找到指定的元素。
截取屏幕截图	使用“高度”和“宽度”参数中指定的自定义尺寸截取您正在使用的移动设备的屏幕截图。
点击	返回一个布尔值变量，用于声明指定的用户界面元素是否存在。 该 API 没有返回值，但如果存在指定的用户界面元素（布尔值），则会对其执行点击操作。
TypeText	获取通过键盘键入的内容，并将其粘贴到当前处于活动状态的用户界面元素中。 要将文本粘贴到所需的元素内，您需要将焦点放在用户界面上要粘贴文本的任意位置。 在自动化应用程序时，您可以使用此 API，您需要通过键盘键入文本，但没有移动自动化可识别的目标元素。

使用 API

使用以下格式从相应的服务调用 API： service.API。 例如 system.GetAsset。

使用移动自动化 API

要使用移动自动化 API，请首先与设备和应用程序建立连接（请访问连接以了解更多信息），然后在此连接上调用所需的自动化方法，例如connection.Tap(<selector>);或var orientation = connection.GetDeviceOrientation(); 。