UiPath.Activities.Api.Base
In this section you can find more information on how to build activities using UiPath.Activities.Api.Base.
IAccessProvider
Runtime service that exposes a method for obtaining OAuth 2.0 access tokens.
Methods
Task<string> GetResourceUrl(string scope, CancellationToken cancellationToken)
| Type | Name | Parameters | Description |
|---|---|---|---|
Task<string> | GetResourceUrl | scope | The scope of this resource. Only the Orchestrator scope is currently supported. |
| cancellationToken | Request cancellation token. |
Task<string> GetResourceUrl(string scope)
Gets the resource server Url for the specified scope. Only the Orchestrator scope is currently supported.
| Type | Name | Parameters | Description |
|---|---|---|---|
Task<string> | GetResourceUrl | scope | The scope of this resource. Only the Orchestrator scope is currently supported. |
Task<string> GetAccessToken(string scope, bool force = false, CancellationToken cancellationToken = default)
Either returns a cached OAuth 2.0 access token for the given scope or, if an access token doesn't exist or force is set to true, it asks the OAuth 2.0 Authorization Server for a token while also caching it and returning it.
| Type | Name | Parameters | Description |
|---|---|---|---|
Task<string> | GetAccessToken | scope | The scope of this resource. Only the Orchestrator scope is currently supported. |
| force | Forces a refresh of the token and provides a new one. | ||
| cancellationToken | Request cancellation token. |
Task<string> GetAccessToken(string scope, bool force = false)
Either returns a cached OAuth 2.0 access token for the given scope or, if an access token doesn't exist or force is set to true, it asks the OAuth 2.0 Authorization Server for a token while also caching it and returning it.
| Type | Name | Parameters | Description |
|---|---|---|---|
Task<string> | GetAccessToken | scope | The scope of this resource. Only the Orchestrator scope is currently supported. |
| force | Forces a refresh of the token and provides a new one. |
IActivitiesSettingsReader
The settings service available at runtime.
Properties
| Type |
Name |
Parameters |
Description |
|---|---|---|---|
| bool |
TryGetValue |
|
Retrieve the currently stored value for a setting using its key. |