UiPath.Studio.Activities.Api.BusyService

In this section you can find more information on how to build activities using UiPath.Studio.Activities.Api.BusyService.

IStudioBusyScope

Note: This feature was introduced in UiPath.Studio.Activities.Api v21.10.

A scope within a long running-process that allows status updates. Requires the feature BusyServiceV1.

Inheritance

IDisposable > IStudioBusyScope

Properties

Type	Name	Description
Task	DisposeTask	The asynchronous dispose operation. This interface should have extended IAsyncDisposable, which is not available in .NET 4. Use this to await the release of the current scope after calling IDisposable.Dispose().

IStudioBusyService

Note: This feature was introduced in UiPath.Studio.Activities.Api v21.10.

Allows displaying a busy indicator on long-running processes with status updates.

Methods

Task<IStudioBusyScope> Begin(string status)

Creates a new busy scope able to present progress. If the service already has a busy scope, the newly created one becomes the primary scope until disposed of. The returned busy scope should be disposed in order to close the indicator.

Parameter Type	Parameter Name	Remarks
string	status	Indicates a status message to present.

Task SetStatus(string status)

Sets a status on a busy screen, if it exists.

Parameter Type	Parameter Name	Remarks
string	status	The status to set.