APIs

Mit APIs können Sie auf die Dienste zugreifen und mit ihnen interagieren, die im Menü Pakete verwalten angeboten werden. Sie können diese APIs verwenden, wenn Sie codierte Automatisierungen entwerfen. Unter Codierte Automatisierungen erfahren Sie mehr über codierte Automatisierungen und wie sie mit APIs gestaltet werden können.

Hinweis: Mit Zu Definition wechseln (F12) können Sie auf die Definition von UiPath-APIs für einen bestimmten Dienst zugreifen. Es wird empfohlen, sich beim Implementieren codierter Automatisierungen nur auf die direkt verfügbar gemachten APIs zu verlassen. Andere APIs, die nicht direkt mit einem Dienst verknüpft sind, können ohne vorherige Ankündigung geändert werden.

Überladungen

APIs enthalten oft Überladungen, was bedeutet, dass sie mehrere Versionen der gleichen Methode mit unterschiedlichen Parameteroptionen bereitstellen. Mit Überladungen können Sie das Verhalten der API basierend auf Ihren spezifischen Anforderungen anpassen. Beispielsweise kann eine UI-Automatisierungs-API eine Überladung enthalten, die einen Timeout-Parameter akzeptiert, um die maximale Zeit anzugeben, die gewartet werden soll, bis ein UI-Element angezeigt wird, bevor die Ausführung beendet wird.

Durch die Verwendung der APIs mit ihren jeweiligen Überladungen können Sie ganz einfach die gewünschte Automatisierungslogik und das gewünschte Verhalten erreichen.

Mobile Automation-APIs

Dieser Abschnitt enthält die APIs, die im Dienst UiPath.MobileAutomation.API.Models zu finden sind.

API	Beschreibung
Dispose	Gibt während der Automatisierung verwendete Ressourcen frei, löscht den von diesen Aktionen belegten Speicher und setzt Connection in seinen ursprünglichen Zustand zurück. Dadurch werden diese Ressourcen für andere Aufgaben auf einem Connection verfügbar.
DrawPattern	Zeichnet einen Pfad, der durch mehrere Punkte auf dem Gerätebildschirm markiert ist. Die Punkte, die den Pfad erstellen, werden vom Pfad des Fingers auf dem Gerätebildschirm aufgezeichnet. Sie können mehrere Fingerpfade hinzufügen, um Bildschirminteraktionen zu simulieren, an denen mehrere Finger beteiligt sind.
ElementExists	Gibt eine boolesche Variable zurück, die angibt, ob ein bestimmtes UI-Element vorhanden ist.
ExecuteCommand	Führen Sie native mobile Befehle aus, die keinem bestimmten Endpunkt zugeordnet sind.
Finalize	Ermöglicht einem Objekt die Durchführung von Bereinigungsvorgängen und die Freigabe von Ressourcen, bevor es von der Garbage-Collection freigegeben wird. Implementiert die Object.Finalize- Methode.
Attribut erhalten (Get Attribute)	Ruft ein Attribut eines angegebenen UI-Elements ab.
GetDeviceOrientation	Ruft die aktuelle Ausrichtung des angegebenen Mobilgeräts ab.
GetLogTypes	Ruft die Protokolltypen von einem Gerät ab, das über das Mobilgerät Connection verbunden ist.
GetPageSource	Ruft die Seitenquelle von einem Mobilgerät ab, das über die Klasse Connection verbunden ist.
GetSelectedItem	Ruft das ausgewählte Element aus einem Ziel-UI-Element ab.
GetSessionIdentifier	Rufen Sie die Sitzungs-ID der aktuellen Mobile Device Manager-Verbindung ab, um HTTP-Befehle an Appium-Endpunkte weiterzuleiten, damit Sie benutzerdefinierte Actionsausführen können.
GetSystemTime	Ruft die aktuelle Uhrzeit des Geräts ab.
GetText	Extracts the text from a specified UI element and returns it as a String variable.
InstallApp	Installiert eine angegebene App auf einem Mobilgerät, das über Connection verbunden ist.
ManageCurrentApplication	Setzt die aktuelle App für diese Sitzung zurück oder startet sie.
ManageOtherApplication	Verwaltet andere Anwendungen mithilfe von Befehlen.
OpenDeepLink	Öffnet einen Deep Link innerhalb einer Anwendung.
OpenUrl	Öffnet eine URL in Chrome. Die aktuell aktive Anwendung muss Chrome sein und mindestens eine geöffnete Registerkarte haben, bevor diese Methode aufgerufen wird.
PositionalSwipe	Wischt zu einer vordefinierten Position auf dem Bildschirm mit Start- und Endpunkten.
PressHardwareButton	Drückt eine Hardware-Schaltfläche auf dem angeschlossenen Gerät.
SaveLogs	Speichern Sie Protokolle eines bestimmten Typs in einer Datei.
SetDeviceGeoLocation	Legt den aktuellen Standort des Geräts fest.
SetDeviceOrientation	Ändert die Ausrichtung des angeschlossenen Geräts und ruft sie anschließend wieder ab.
SetSelectedItem	Legt das ausgewählte Element auf einem Ziel-UI-Element fest.
SetText	Gibt den angegebenen Text in ein Ziel-UI-Element ein, das von Mobile Automation erkannt wird.
Wischen	Der Wischvorgang durchläuft mehrere Wischvorgänge auf der Liste (bis zu MaxNumberOfSwipes), bis das angegebene Element gefunden wird.
Screenshot anfertigen (Take Screenshot)	Erstellt einen Screenshot des Bildschirms des verwendeten Mobilgeräts mit benutzerdefinierten Abmessungen, die in den Parametern Höhe und Breite angegeben sind.
Tap	Gibt eine boolesche Variable zurück, die angibt, ob ein bestimmtes UI-Element vorhanden ist. Die API hat keinen Rückgabewert, aber wenn das angegebene UI-Element vorhanden ist (boolescher Wert), dann werden Tipp-Operationen dafür ausgeführt.
TypeText	Fügt den über die Tastatur eingegebenen Inhalt in das derzeit aktive UI-Element ein. Um den Text in das gewünschte Element einzufügen, müssen Sie den Fokus auf eine beliebige Stelle auf der Benutzeroberfläche richten, an der Sie den Text einfügen möchten. Sie können diese API verwenden, wenn Sie Anwendungen automatisieren, für die Sie Text über die Tastatur eingeben müssen, aber kein Zielelement, das von Mobile Automation erkannt wird.

Verwenden von APIs

Verwenden Sie das folgende Format, um eine API vom entsprechenden Dienst aufzurufen: service.API. Beispiel: system.GetAsset.

Verwenden von Mobile Automation-APIs

Um Mobile Automation APIs zu verwenden, stellen Sie zuerst eine Verbindung zu Ihrem Gerät und Ihrer Anwendung her (weitere Informationen finden Sie unter Verbindung) und rufen dann die gewünschten Automatisierungsmethoden für diese Verbindung auf, z. B. connection.Tap(<selector>); oder var orientation = connection.GetDeviceOrientation();.