UiPath.Studio.Activities.Api.Licensing

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

ILicenseApiService

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

Service used to retrieve license and user sign-in information.

Methods

string GetLicenseEdition()

Retrieves license information as defined in LicenseEdition.

UserInfo GetUserInfo()

Retrieves sign-in information for the current user as defined in UserInfoState.

void RegisterUserInfoHandler(Action<UserInfo> userInfoStateHandler)

Registers a function to be invoked when the user state changes.

Parameter Type	Parameter Name	Remarks
Action<UserInfo>	userInfoStateHandler	A function that accepts a user's info as parameter which reflects the new user info state.

LicenseEdition

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

A list of license states for the current product.

Constants

Type	Name	Description
string	Undefined	License not yet initialized.
string	Basic	License associated with the Free SKU offering.
string	Community	Community license.
string	Academic	The license offered for educational purposes.
string	Trial	Trial license.
string	Enterprise	Enterprise license.
string	UiPathers	License used by UiPath employees.

UserInfo

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

Information about a user's sign-in state.

Properties

Type	Name	Description
string	UserInfoState	The state of the current user as defined in UserInfoState.
string	UserId	The encrypted user ID.

UserInfoState

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

A list of sign-in states for a given user.

Constants

Type	Name	Description
string	SignInUnavailable	User status when the user is signed out and sign-in is unavailable.
string	SignedOut	User status when the user is signed out.
string	SignedInUnconfirmed	User status when the user is signed in but sign-in not completed.
string	SignedInConfirmed	User status when the user is signed in.