UiPath.Studio.Activities.Api

Nesta seção, você pode encontrar mais informações sobre como criar atividades usando o UiPath.Studio.Activities.Api.

AssetRequestParameters

Observação: essa funcionalidade foi introduzida na versão 21.10 do UiPath.Studio.Activities.Api.

Estrutura usada para consultar o IAssetApiService para recuperar ativos do Orchestrator.

Propriedades

Tipo	Name
String	Expandir
String	Filtro
String	Selecionar
String	Ordenar por
int?	Superior
int?	Pular
bool?	Contagem

DesignFeatureKeys

Lista de chaves de funcionalidades para verificar se um recurso está disponível.

Propriedades

Tipo	Name	Valor	Introduzido em
String	Configurações	SettingsV1	Studio 2019.10
String	SettingsV2	SettingsV2	Studio 2020.4
String	SettingsV3	SettingsV3	Studio 2021.10
String	Tema	ThemeV1	Studio 2019.10
String	Assistentes	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	Analisador de Fluxo de Trabalho	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	Gatilhos de atividades	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	Repo. de Objetos	ObjectRepositoryV1	Studio 2020.10
String	SimpleObjectRepository	SimpleObjectRepositoryV1	Studio 2021.10
String	ConfiguraçõesOrganizacionais	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	API do 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

Considerações

Você pode verificar se um recurso está disponível invocando o método IHasFeature.HasFeature usando a chave.

IAssetApiService

Observação: essa funcionalidade foi introduzida na versão 21.10 do UiPath.Studio.Activities.Api.

Exibe a API para executar operações relacionadas a ativos.

Métodos

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

Retorna uma lista de strings que representam os nomes de ativos na pasta especificada. Se uma pasta não for especificada, a pasta padrão será usada.

Tipo de parâmetro	Nome do parâmetro	Considerações
int	Superior	O número de ativos a serem recuperados.
String	folder	A pasta em que os ativos são definidos. Se null, todos os ativos visíveis para os usuários atuais serão recuperados.

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

Retorna uma lista de strings que representam os nomes de ativos na pasta especificada. Se uma pasta não for especificada, a pasta padrão será usada.

Tipo de parâmetro	Nome do parâmetro	Considerações
AssetRequestParameters	Parâmetros de solicitação	Parâmetros de consulta avançados. Consulte ParâmetrosDeRequisiçãoDeAtivo.
String	folder	A pasta em que os ativos são definidos. Se null, todos os ativos visíveis para os usuários atuais serão recuperados.

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

Retorna a lista de pastas acessíveis.

Tipo de parâmetro	Nome do parâmetro	Considerações
int	Superior	O número de pastas a serem recuperadas.

IExtensionsInstallerService

Uma maneira de instalar extensões de um pacote de atividades.

Métodos

void InstallExtension(string extensionName)

Exibe as extensões instaladas para as atividades.

Tipo de parâmetro	Nome do parâmetro	Considerações
String	extensionName	O nome da extensão.

void InstallExcelAddIn()

Dispara o processo de instalação do Suplemento do Excel para UiPath para o StudioX.

IOrchestratorApiService

Observação: essa funcionalidade foi introduzida na versão 21.10 do UiPath.Studio.Activities.Api.

wrapper de nível superior para operações relacionadas ao Orchestrator. Exposto em IWorkflowDesignApi.

Propriedades

Tipo	Name	Description
IAssetApiService	AssetApiService	Uma referência a uma API do Orchestrator relacionada a ativos.

IOrganizationalSettingsService

Observação: essa funcionalidade foi introduzida na versão 21.4 do UiPath.Studio.Activities.Api.

Interface que descreve como ler as configurações organizacionais.

Métodos

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

Recupera várias configurações organizacionais de uma origem de dados e retorna um mapa das chaves encontradas e seus valores.

Tipo de parâmetro	Nome do parâmetro	Considerações
IEnumerable<string>	Chaves	Uma enumeração das chaves de configuração organizacional.
CancellationToken	ct	Um dicionário que mapeia cada uma das chaves encontradas e o respectivo valor.

IRegisterAnalyzerConfiguration

Componente chamado pelo aplicativo analisador em cada assembly de regra para configurar o analisador do host.

Métodos

void Initialize(IAnalyzerConfigurationService workflowAnalyzerConfigService)

Oferece um ponto de injeção para o assembly de implementação para acessar recursos do IAnalyzerConfigurationService .

Tipo de parâmetro	Nome do parâmetro	Considerações
ServiçoDeConfiguraçãoDoAnalizador	workflowAnalyzerConfigService	Referência ao IAnalyzerConfigurationService a ser usado para registrar regras.

IRegisterWorkflowDesignApi

Registro de API do designer de fluxo de trabalho. Ele segue o mesmo padrão que IRegisterMetadata. O Studio verificará os tipos em seu assembly para implementações dessa interface. Se uma implementação for encontrada, uma instância será criada pelo Studio e a instância da API será entregue por meio de IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi.

Observação:

As versões mais antigas do Studio que não vêm com a API não poderão carregar seu assembly. Se quiser manter a compatibilidade com as versões mais antigas do Studio, em vez de implementar essa interface, adicione um método Initialize(object) na implementação de IRegisterMetadata que o Studio descobrirá por meio da reflexão. Converta o parâmetro de objeto para IWorkflowDesignApi no seu lado. A mesma instância IWorkflowDesignApi pode ser recuperada do contexto do designer por meio de GetService.

Métodos

void Initialize(IWorkflowDesignApi api)

Registre a instância da API.

Tipo de parâmetro	Nome do parâmetro	Considerações
IWorkflowDesignApi	API	Uma referência à IWorkflowDesignApi a ser usada para acessar as funcionalidades do Studio.

IStudioDesignSettingsService

Observação: essa funcionalidade foi introduzida na versão 21.4 do UiPath.Studio.Activities.Api.

Interface para funcionalidades relacionadas ao painel do Designer do Studio.

Propriedades

Tipo	Name	Considerações
Bool	Comportamento moderno	Se definido como true, a Experiência de Design Moderno está habilitada.
Bool	UseConnectionService	Se definido como true, as conexões do Integration Service são habilitadas por padrão. Requer o Studio 2021.10 ou posterior.

IWindowOperationsService

Observação: essa funcionalidade foi introduzida na versão 21.4 do UiPath.Studio.Activities.Api.

O ponto de entrada para operações relacionadas a janelas.

Métodos

IntPtr GetMainWindowHandle()

Retorna um identificador para a janela principal do Studio.

void MinimizeMainWindow()

Minimiza a janela principal do Studio.

void MaximizeMainWindow()

Maximiza a janela principal do Studio.

void RestoreMainWindow()

Restaura a janela principal do Studio.

void DisableMainWindow()

Desabilita a janela principal do Studio.

void EnableMainWindow()

Habilita a janela principal do Studio.

IWorkflowDesignApi

Ponto de entrada na API. Você pode obter uma instância dessa interface implementando IRegisterWorkflowDesignApi ou adicionando um void Initialize(object) em sua implementação da interface IRegisterMetadata.

Herança

IHasFeature > IWorkflowDesignApi

Propriedades

Tipo	Name	Acessadores
IOrganizationalSettingsService	ConfiguraçõesOrganizacionais	get
IActivitiesSettingsService	Configurações	get
ITelemetryService	Telemetry	get
IThemeService	Tema	get
IWizardsService	Assistentes	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

Considerações

Essa API está disponível tanto no processo do Studio quanto no Analisador de Fluxo de Trabalho.