sdk
latest
false
Developer Guide
Last updated Oct 25, 2024

UiPath.Studio.Activities.Api.PackageBindings

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

ConnectionFilterProperties

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

Defines the connection filter properties.

Constants

Type

Name

Description

string

ParentFolderId

The ID of the parent folder.

ConnectionMetadata

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

Defines the connection metadata.

Constants

Type

Name

Description

string

ParentResourceKey

The parent resource key.

ConnectionProperties

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

Connection property names as they appear in the bindings export.

Constants

Type

Name

Description

string

ConnectionId

The name of the connection resource.

string

UseConnectionService

The source of the connection token - local / Integration service.

string

Connector

The connection provider. e.g GMail, Office365.

ConnectionSources

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

Defines where the connection is defined.

Constants

Type

Name

Description

string

Local

The connection is stored in a local repository.

string

Service

The connection is stored in Orchestrator.

IPackageBindingModel

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

Describes the Orchestrator bindings information in an activity package.

Properties

Type

Name

Description

string

BindingType

Type of binding, for example asset, queues, connections.

IList<PackageBindingProperty>

Properties

Binding properties. Used only in Orchestrator 2021.10.

string

Metadata

Binding-specific information (description of the object). Used only in Orchestrator 2021.10. Requires Studio 2021.10 or later.

IList<PackageBindingProperty>

MetadataV2

Properties of the bound object. Requires Studio and Orchestrator 2022.4 or later.

PackageBindingProperty

Key

Unique key of the binding. Requires Studio and Orchestrator 2022.4 or later.

PackageBindingProperty

Description

Description of the binding. Requires Studio and Orchestrator 2022.4 or later.

IPackageBindingsService

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

Exposes the functionality of generating package bindings for activity types.

Methods

void AddPackageBindingMetadata(PackageBindingMetadata packageBindingMetadata)

Registers binding information.

Parameter Type

Parameter Name

PackageBindingMetadata

packageBindingMetadata

PackageBindingMetadata

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

Binding metadata for the activity.

Properties

Type

Name

Description

string

ActivityType

Type FullName of the related activity, for example: UiPath.Core.Activities.GetRobotAsset.

string

BindingType

Binding type of the activity, as defined by activities, for example: asset, queue, process, storage, connection.

IList<PropertyMetadata>

PropertiesMetadata

List of properties metadata.

PropertyMetadata

Key

Property used to generate the unique identifier for the resource, for example: "googlesheetsv4.UserDefinedValue". Requires Studio 2022.4 or later.

PropertyMetadata

Description

User-defined description to specify the intended usage of the resource. Requires Studio 2022.4 or later.

IList<PropertyMetadata>

Metadata

Properties used to tailor the bindings override experience, for example: "Connector" : "googlesheetsv4". Requires Studio 2022.4 or later.

PackageBindingMetadataKeys

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

Constants to use when adding package bindings.

Constants

Type

Name

Description

string

PackageBinding

The PackageBinding metadata key.

string

PackageBindingProperty

The PackageBindingProperty metadata key.

PackageBindingProperty

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

Describes a property of the binding.

Properties

Type

Name

Description

string

Name

The name of the property.

string

Value

The value of the property.

bool

IsExpression

Whether the value is an expression,

For example, for an asset called "bananas" used in a process, the asset binding will have a binding property with the name field equal to name, value equal to bananas and IsExpression equal to false.

PackageBindingTypes

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

Common BindingType constants.

Constants

Type

Name

Description

string

Connection

Represents a binding of type Connection.

PropertyMetadata

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

Activity property metadata.

Properties

Type

Name

Description

string

ContractName

Property contract name, as specified by activities, for example: Value, FolderPath, Path, Directory.

string

PropertyName

The actual property name of the activity class, for example nameof(GetRobotAsset.AssetName), nameof(AddTransactionItem.QueueType), nameof(PostponeTransactionItem.FolderPath).

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.