UiPath.Studio.Activities.Api

Dans cette section, vous trouverez plus d'informations sur la création d'activités à l'aide de UiPath.Studio.Activities.Api.

AssetRequestParameters

Remarque : cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v21.10.

Structure utilisée pour interroger le IAssetApiService afin de récupérer les ressources Orchestrator.

Propriétés

Saisie de texte	Nom
string	Développer
string	Filtrer (Filter)
string	Sélectionner
string	Trier par
int?	Haut
int?	Ignorer
bool?	Nombre

DesignFeatureKeys

Liste de touches de fonctionnalité permettant de vérifier si une fonctionnalité est disponible.

Propriétés

Saisie de texte	Nom	Valeur (Value)	Introduit en
string	Paramètres	SettingsV1	Studio 2019.10.x
string	SettingsV2	SettingsV2	Studio 2020.4
string	SettingsV3	SettingsV3	Studio 2021.10
string	Thème (Theme)	ThemeV1	Studio 2019.10.x
string	Assistants	WizardsV1	Studio 2019.10.x
string	WizardsV2	WizardsV2	Studio 2020.4
string	WizardsV3	WizardsV3	Studio 2020.4
string	WizardsV4	WizardsV4	Studio 2020.10
string	AccessProvider	AccessProviderV1	Studio 2019.10.x
string	AccessProviderV2	AccessProviderV2	Studio 2020.10
string	AccessProviderV3	AccessProviderV3	Studio 2020.10
string	Telemetry	TelemetryV1	Studio 2019.10.x
string	Analyseur de workflow	WorkflowAnalyzerV1	Studio 2019.10.x
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	Notes de publication
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	Notes de publication
string	WorkflowAnalyzerV12	WorkflowAnalyzerV12	Notes de publication
string	WorkflowAnalyzerV13	WorkflowAnalyzerV13	Notes de publication
string	ScopedActivities	ScopedActivitiesV1	Studio 2020.4
string	ActivitySynonyms	ActivitySynonymsV1	Studio 2021.10
string	Déclencheurs d'activité	ActivityTriggersV1	Notes de publication
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	Notes de publication
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	Réf. d’objets	ObjectRepositoryV1	Studio 2020.10
string	SimpleObjectRepository	SimpleObjectRepositoryV1	Studio 2021.10
string	Paramètres organisationnels	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	Notes de publication
string	API Orchestrator	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

Remarques

Vous pouvez vérifier si une fonctionnalité est disponible en invoquant la méthode IHasFeature.HasFeature à l'aide de la clé.

IAssetApiService

Remarque : cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v21.10.

Expose l'API pour effectuer des opérations liées aux ressources.

Méthodes

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

Renvoie une liste de chaînes représentant les noms de ressources dans le dossier spécifié. Si aucun dossier n'est spécifié, le dossier par défaut est utilisé.

Type de paramètre	Nom du paramètre	Remarques
int	Haut	Nombre d'actifs à récupérer.
string	folder	Le dossier dans lequel les ressources sont définies. Si null, toutes les ressources visibles par les utilisateurs actuels seront récupérées.

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

Renvoie une liste de chaînes représentant les noms de ressources dans le dossier spécifié. Si aucun dossier n'est spécifié, le dossier par défaut est utilisé.

Type de paramètre	Nom du paramètre	Remarques
AssetRequestParameters	Paramètres de requête	Paramètres de requête avancés. Voir AssetRequestParameters.
string	folder	Le dossier dans lequel les ressources sont définies. Si null, toutes les ressources visibles par les utilisateurs actuels seront récupérées.

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

Renvoie la liste des dossiers accessibles.

Type de paramètre	Nom du paramètre	Remarques
int	Haut	Le nombre de dossiers à récupérer.

IExtensionsInstallerService

Un moyen d'installer des extensions à partir d'un package d'activités.

Méthodes

void InstallExtension(string extensionName)

Expose les extensions installées aux activités.

Type de paramètre	Nom du paramètre	Remarques
string	extensionName	Nom de l'extension.

void InstallExcelAddIn()

Déclenche le processus d'installation du complément Excel pour UiPath pour StudioX.

IOrchestratorApiService

Remarque : cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v21.10.

Wrapper de niveau supérieur pour les opérations liées à Orchestrator. Exposé dans IWorkflowDesignApi.

Propriétés

Saisie de texte	Nom	Description
IAssetApiService	AssetApiService	Référence à une API Orchestrator liée aux ressources.

IOrganizationalSettingsService

Remarque : cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v21.4.

Interface qui décrit comment lire les paramètres organisationnels.

Méthodes

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

Récupère plusieurs paramètres organisationnels à partir d'une source de données et renvoie une carte des clés trouvées et de leurs valeurs.

Type de paramètre	Nom du paramètre	Remarques
IEnumerable<string>	Clés	Une énumération de clés de paramètres organisationnels.
CancellationToken	ct	Un dictionnaire qui mappe chacune des clés trouvées et sa valeur.

IRegisterAnalyzerConfiguration

Composant appelé par l'application de l'analyseur dans chaque assembly de règles, afin de configurer l'analyseur hôte.

Méthodes

void Initialize(IAnalyzerConfigurationService workflowAnalyzerConfigService)

Offre un point d’injection à l’assembly d’implémentation afin d’accéder aux capacités de IAnalyzerConfigurationService .

Type de paramètre	Nom du paramètre	Remarques
Service de configuration IAnalyzer	workflowAnalyzerConfigService	Référence à IAnalyzerConfigurationService à utiliser pour enregistrer les règles.

IRegisterWorkflowDesignApi

Enregistrement de l'API du concepteur de workflow. Il suit le même modèle que IRegisterMetadata. Studio analysera les types de votre assembly à la recherche d'implémentations de cette interface. Si une implémentation est trouvée, une instance est créée par Studio et l'instance d'API est transmise via IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi.

Remarque :

Les anciennes versions de Studio qui ne sont pas fournies avec l'API ne pourront pas charger votre assembly. Si vous souhaitez conserver la compatibilité avec les anciennes versions de Studio, au lieu d'implémenter cette interface, ajoutez une méthode Initialize(object) sur l'implémentation de IRegisterMetadata que Studio découvrira par réflexion. Transmettez le paramètre d'objet à IWorkflowDesignApi de votre côté. La même instance de IWorkflowDesignApi peut être récupérée à partir du contexte du concepteur via GetService.

Méthodes

void Initialize(IWorkflowDesignApi api)

Enregistrez l'instance d'API.

Type de paramètre	Nom du paramètre	Remarques
IWorkflowDesignApi	API	Référence à IWorkflowDesignApi à utiliser pour accéder aux fonctionnalités de Studio.

IStudioDesignSettingsService

Remarque : cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v21.4.

Interface pour les fonctionnalités liées au panneau Studio Designer .

Propriétés

Saisie de texte	Nom	Remarques
Bool	Comportement moderne	Si le paramètre est défini sur true, l'expérience de conception moderne ( Modern Design Experience) est activée.
Bool	UseConnectionService	Si elles sont définies sur true, les connexions Integration Service sont activées par défaut. Nécessite Studio 2021.10 ou une version ultérieure.

IWindowOperationsService

Remarque : cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v21.4.

Le point d’entrée pour les opérations liées à la fenêtre.

Méthodes

IntPtr GetMainWindowHandle()

Renvoie une poignée à la fenêtre principale de Studio.

void MinimizeMainWindow()

Réduit la fenêtre principale de Studio.

void MaximizeMainWindow()

Agrandit la fenêtre principale de Studio.

void RestoreMainWindow()

Restaure la fenêtre principale de Studio.

void DisableMainWindow()

Désactive la fenêtre principale de Studio.

void EnableMainWindow()

Active la fenêtre principale de Studio.

IWorkflowDesignApi

Point d’entrée dans l’API. Vous pouvez obtenir une instance de cette interface en implémentant IRegisterWorkflowDesignApi ou en ajoutant un void Initialize(object) dans votre implémentation de l'interface IRegisterMetadata.

Héritage

IHasFeature > IWorkflowDesignApi

Propriétés

Saisie de texte	Nom	Accesseurs
IOrganizationalSettingsService	Paramètres organisationnels	get
IActivitiesSettingsService	Paramètres	get
ITelemetryService	Telemetry	get
IThemeService	Thème (Theme)	get
IWizardsService	Assistants	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

Remarques

Cette API est disponible à la fois dans les processus Studio et dans l'analyseur de workflow.