UiPath.Studio.Activities.Api

In diesem Abschnitt finden Sie weitere Informationen zum Erstellen von Aktivitäten mit UiPath.Studio.Activities.Api.

AssetRequestParameters

Hinweis: Diese Funktion wurde in UiPath.Studio.Activities.Api v21.10 eingeführt.

Struktur, die zum Abfragen von IAssetApiService verwendet wird, um Orchestrator-Assets abzurufen.

Eigenschaften

Typ	Name
string	Erweitern
string	Filter
string	Auswählen
string	Sortieren nach
int?	Oben
int?	Überspringen
bool?	Anzahl

DesignFeatureKeys

Liste der Funktionstasten, um zu überprüfen, ob eine Funktion verfügbar ist.

Eigenschaften

Typ	Name	Wert	Eingeführt in
string	Einstellungen	SettingsV1	Studio 2019.10
string	SettingsV2	SettingsV2	Studio 2020.4
string	SettingsV3	SettingsV3	Studio 2021.10
string	Thema	ThemeV1	Studio 2019.10
string	Assistenten	WizardsV1	Studio 2019.10
string	WizardsV2	WizardsV2	Studio 2020.4
string	WizardsV3	WizardsV3	Studio 2020.4
string	WizardsV4	WizardsV4	Studio 2020.10
string	AccessProvider	AccessProviderV1	Studio 2019.10
string	AccessProviderV2	AccessProviderV2	Studio 2020.10
string	AccessProviderV3	AccessProviderV3	Studio 2020.10
string	Telemetry	TelemetryV1	Studio 2019.10
string	Workflow-Analyse	WorkflowAnalyzerV1	Studio 2019.10
string	WorkflowAnalyzerV2	WorkflowAnalyzerV2	Studio 2019.10.2
string	WorkflowAnalyzerV3	WorkflowAnalyzerV3	Studio 2019.10.3
string	ProjectProperties	ProjectPropertiesV1	Studio 2020.4
string	ProjectPropertiesV2	ProjectPropertiesV2	Studio 2021.10
string	ProjectPropertiesV3	ProjectPropertiesV3	Studio 2022.4
string	WorkflowAnalyzerV4	WorkflowAnalyzerV4	Studio 2020.4
string	WorkflowAnalyzerV5	WorkflowAnalyzerV5	Studio 2020.4.2
string	WorkflowAnalyzerV6	WorkflowAnalyzerV6	Studio 2020.10
string	WorkflowAnalyzerV7	WorkflowAnalyzerV7	Studio 2020.10
string	WorkflowAnalyzerV8	WorkflowAnalyzerV8	Studio 2020.10.3
string	WorkflowAnalyzerV9	WorkflowAnalyzerV9	Studio 2021.4
string	WorkflowAnalyzerV10	WorkflowAnalyzerV10	Studio 2021.10
string	WorkflowAnalyzerV11	WorkflowAnalyzerV11	Studio 2022.4
string	WorkflowAnalyzerV12	WorkflowAnalyzerV12	Studio 2022.4
string	WorkflowAnalyzerV13	WorkflowAnalyzerV13	Studio 2022.4
string	ScopedActivities	ScopedActivitiesV1	Studio 2020.4
string	ActivitySynonyms	ActivitySynonymsV1	Studio 2021.10
string	Aktivitäts-Trigger	ActivityTriggersV1	Studio 2022.4
string	AttendedActivities	AttendedActivitiesV1	Studio 2021.10
string	InstallExtensions	InstallExtensionsV1	Studio 2020.4
string	InstallExcelAddIn	InstallExcelAddInV1	Studio 2020.10
string	ActivityFactory	ActivityFactoryV1	Studio 2020.10
string	ActivityFactoryV2	ActivityFactoryV2	Studio 2020.10
string	ActivityFactoryV3	ActivityFactoryV3	Studio 2021.4
string	ActivityFactoryV4	ActivityFactoryV4	Studio 2022.4
string	StudioDesignSettings	StudioDesignSettingsV1	Studio 2020.10
string	StudioDesignSettingsV2	StudioDesignSettingsV2	Studio 2021.10
string	ExpressionService	ExpressionServiceV1	Studio 2020.10
string	DesignTimeExpressionExpanderService	DesignTimeExpressionExpanderServiceV1	Studio 2021.10
string	ExclusiveScopedActivities	ExclusiveScopedActivitiesV1	Studio 2020.10
string	MockingCapabilities	MockingCapabilitiesV1	Studio 2020.10
string	MockingCapabilitiesV2	MockingCapabilitiesV2	Studio 2020.10
string	ObjectRecorderHighlight	ObjectRecorderHighlight	Studio 2021.10
string	ObjectRecorderCurrentElements	ObjectRecorderCurrentElements	Studio 2021.10
string	Objekt-Repository	ObjectRepositoryV1	Studio 2020.10
string	SimpleObjectRepository	SimpleObjectRepositoryV1	Studio 2021.10
string	Organisationseinstellungen	OrganizationalSettingsV1	Studio 2020.10.3
string	WindowOperations	WindowOperationsV1	Studio 2021.4
string	WindowOperationsV2	WindowOperationsV2	Studio 2021.4
string	PackageBindings	PackageBindingsV1	Studio 2021.4
string	PackageBindingsV2	PackageBindingsV2	Studio 2021.10
string	PackageBindingsV3	PackageBindingsV3	Studio 2022.4
string	Orchestrator-API	OrchestratorApiV1	Studio 2021.10
string	LicenseApi	LicenseApiV1	Studio 2021.10
string	BusyService	BusyServiceV1	Studio 2021.10
string	ModernClassicSetting	ModernClassicSettingV1	Studio 2021.10
string	AutoCaptureElements	AutoCaptureElements	Studio 2021.10

Bemerkungen

Sie können überprüfen, ob eine Funktion verfügbar ist, indem Sie die Methode IHasFeature.HasFeature mithilfe des Schlüssels aufrufen.

IAssetApiService

Hinweis: Diese Funktion wurde in UiPath.Studio.Activities.Api v21.10 eingeführt.

Macht die API zur Durchführung von Asset-bezogenen Vorgängen verfügbar.

Methoden

Task<IEnumerable<string>> GetAssets(int top, string folder = null)

Gibt eine Liste von Zeichenfolgen zurück, die die Asset-Namen im angegebenen Ordner darstellen. Wenn kein Ordner angegeben ist, wird der Standardordner verwendet.

Parametertyp	Parametername	Bemerkungen
int	Oben	Die Anzahl der abzurufenden Assets.
string	folder	Der Ordner, in dem die Assets definiert sind. Bei nullwerden alle für die aktuellen Benutzer sichtbaren Assets abgerufen.

Task<IEnumerable<string>> GetAssets(AssetRequestParameters requestParameters, string folder = null)

Gibt eine Liste von Zeichenfolgen zurück, die die Asset-Namen im angegebenen Ordner darstellen. Wenn kein Ordner angegeben ist, wird der Standardordner verwendet.

Parametertyp	Parametername	Bemerkungen
AssetRequestParameters	Anforderungsparameter	Erweiterte Abfrageparameter. Siehe AssetRequestParameters.
string	folder	Der Ordner, in dem die Assets definiert sind. Bei nullwerden alle für die aktuellen Benutzer sichtbaren Assets abgerufen.

Task<IEnumerable<string\>\> GetAssetFolders(int top)

Gibt die Liste der zugänglichen Ordner zurück.

Parametertyp	Parametername	Bemerkungen
int	Oben	Die Anzahl der abzurufenden Ordner.

IExtensionsInstallerService

Eine Möglichkeit, Erweiterungen aus einem Aktivitätspaket zu installieren.

Methoden

void InstallExtension(string extensionName)

Macht installierte Erweiterungen für Aktivitäten verfügbar.

Parametertyp	Parametername	Bemerkungen
string	extensionName	Der Name der Erweiterung.

void InstallExcelAddIn()

Löst den Installationsvorgang für das UiPath-Excel-Add-in für StudioX aus.

IOrchestratorApiService

Hinweis: Diese Funktion wurde in UiPath.Studio.Activities.Api v21.10 eingeführt.

Wrapper der obersten Ebene für Orchestrator-bezogene Vorgänge. In IWorkflowDesignApi verfügbar gemacht.

Eigenschaften

Typ	Name	Beschreibung
IAssetApiService	AssetApiService	Ein Verweis auf eine Asset-bezogene Orchestrator-API.

IOrganizationalSettingsService

Hinweis: Diese Funktion wurde in UiPath.Studio.Activities.Api v21.4 eingeführt.

Schnittstelle, die beschreibt, wie Organisationseinstellungen gelesen werden.

Methoden

Task<Dictionary<string, object>> GetSettingsAsync(IEnumerable<string\> keys, CancellationToken ct = default(CancellationToken))

Ruft mehrere Organisationseinstellungen aus einer Datenquelle ab und gibt eine Zuordnung der gefundenen Schlüssel und ihrer Werte zurück.

Parametertyp	Parametername	Bemerkungen
IEnumerable<string>	Tasten	Eine Aufzählung von Schlüsseln für Organisationseinstellungen.
CancellationToken	ct	Ein Wörterbuch, das jeden der gefundenen Schlüssel und dessen Wert zuordnet.

IRegisterAnalyzerConfiguration

Komponente, die von der Analyseanwendung in jeder Regelassembly aufgerufen wird, um die Hostanalyse zu konfigurieren.

Methoden

void Initialize(IAnalyzerConfigurationService workflowAnalyzerConfigService)

Bietet der implementierenden Assembly einen Injektionspunkt an, um auf die Funktionen von IAnalyzerConfigurationService zugreifen zu können.

Parametertyp	Parametername	Bemerkungen
IAnalyzerConfigurationService	workflowAnalyzerConfigService	Ein Verweis auf IAnalyzerConfigurationService, der zum Registrieren von Regeln verwendet werden soll.

IRegisterWorkflowDesignApi

Registrierung der Workflow-Designer-API. Es folgt dem gleichen Muster wie IRegisterMetadata. Studio durchsucht die Typen in Ihrer Assembly nach Implementierungen dieser Schnittstelle. Wenn eine Implementierung gefunden wird, wird eine Instanz von Studio erstellt und die API-Instanz wird an IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi) übergeben.

Hinweis:

Ältere Studio-Versionen, die nicht mit der API ausgeliefert werden, können Ihre Assembly nicht laden. Wenn Sie die Kompatibilität mit den älteren Studio-Versionen beibehalten möchten, anstatt diese Schnittstelle zu implementieren, fügen Sie eine Initialize(object) -Methode für die Implementierung von IRegisterMetadata hinzu, die Studio durch Reflexion erkennt. Wandeln Sie den Objektparameter in IWorkflowDesignApi auf Ihrer Seite um. Dieselbe IWorkflowDesignApi-Instanz kann aus dem Designerkontext über GetService abgerufen werden.

Methoden

void Initialize(IWorkflowDesignApi api)

Registrieren Sie die API-Instanz.

Parametertyp	Parametername	Bemerkungen
IWorkflowDesignApi	API	Ein Verweis auf IWorkflowDesignApi , der für den Zugriff auf Studio-Funktionen verwendet werden soll.

IStudioDesignSettingsService

Hinweis: Diese Funktion wurde in UiPath.Studio.Activities.Api v21.4 eingeführt.

Schnittstelle für Funktionen im Zusammenhang mit dem Studio Designer -Panel.

Eigenschaften

Typ	Name	Bemerkungen
Bool	Modernes Verhalten	Wenn truefestgelegt ist, ist die moderne Designumgebung aktiviert.
Bool	UseConnectionService	Wenn auf truefestgelegt, sind Integration Service-Verbindungen standardmäßig aktiviert. Erfordert Studio 2021.10 oder höher.

IWindowOperationsService

Hinweis: Diese Funktion wurde in UiPath.Studio.Activities.Api v21.4 eingeführt.

Der Einstiegspunkt für fensterbezogene Vorgänge.

Methoden

IntPtr GetMainWindowHandle()

Gibt ein Handle für das Hauptfenster von Studio zurück.

void MinimizeMainWindow()

Minimiert das Hauptfenster von Studio.

void MaximizeMainWindow()

Maximiert das Hauptfenster von Studio.

void RestoreMainWindow()

Stellt das Hauptfenster von Studio wieder her.

void DisableMainWindow()

Deaktiviert das Hauptfenster von Studio.

void EnableMainWindow()

Aktiviert das Hauptfenster von Studio.

IWorkflowDesignApi

Einstiegspunkt in die API. Sie können eine Instanz dieser Schnittstelle erhalten, indem Sie IRegisterWorkflowDesignApi implementieren oder einen void Initialize(object) in Ihrer Implementierung der IRegisterMetadata-Schnittstelle hinzufügen.

Vererbung

IHasFeature > IWorkflowDesignApi

Eigenschaften

Typ	Name	Accessoren
IOrganizationalSettingsService	Organisationseinstellungen	get
IActivitiesSettingsService	Einstellungen	get
ITelemetryService	Telemetry	get
IThemeService	Thema	get
IWizardsService	Assistenten	get
IAccessProvider	AccessProvider	get
IProjectPropertiesService	ProjectPropertiesService	get
IScopedActivitiesService	ScopedActivitiesService	get
IActivitySynonymService	ActivitySynonymService	get
IAttendedActivityService	AttendedActivityService	get
IDesignTimeExpressionExpanderService	DesignTimeExpressionExpanderService	get
IActivityFactoryRepository	ActivityFactory	get
ILibraryService	ObjectLibrary	get
IExtensionsInstallerService	ExtensionsInstallerService	get
IStudioDesignSettingsService	StudioDesignSettings	get
IExpressionService	ExpressionService	get
IExclusiveScopedActivitiesService	ExclusiveScopedActivitiesService	get
IMockActivityService	MockActivityService	get
IWindowOperationsService	WindowOperations	get
IPackageBindingsService	PackageBindings	get
ILicenseApiService	LicenseApiService	get
IStudioBusyService	BusyService	get
IActivityTriggerService	ActivityTriggerService	get

Bemerkungen

Diese API ist sowohl in Studio- als auch in Workflow-Analyse-Prozessen verfügbar.