Changelog
Data Exchange SDK 5.1.1
Following are the recent changes made to the Data Exchange SDK 5.1.1 version.
Release information
Download and extract the zip file of Data Exchange SDK installable from the Feedback portal.
- Build name: Autodesk.DataExchange.5.1.1-beta.zip
- Date: 12-Nov-2024
New Features
- The Data Exchange SDK has now been updated to support .NET 8.
Updated
Here is an overview of the API’s Updated items.
Autodesk.DataExchange.SDK.UI
Namespace | Class | Old method signature | New method signature | Description |
---|---|---|---|---|
Autodesk.DataExchange.BaseModels | BaseExchangeModel | public abstract void SelectElements(List<string> exchangeIds) | public abstract Task<bool> SelectElementsAsync(List<string> exchangeIds) | Highlights the data exchange elements on platform application. |
Autodesk.DataExchange.BaseModels | BaseWriteOnlyExchangeModel / BaseReadWriteExchangeModel | public virtual bool DeleteExchange(ExchangeItem exchangeItem) | public virtual Task<bool> DeleteExchangeAsync(ExchangeItem exchangeItem) | Deletes Exchange. |
Autodesk.DataExchange.BaseModels | BaseWriteOnlyExchangeModel / BaseReadWriteExchangeModel | public virtual bool ValidateCanCreateExchange(out List<string> validationErrors) | public virtual Task<IEnumerable<string>> ValidateCanCreateExchangeAsync() | Asynchronously validates if exchange creation can proceed. This method can be overridden by the host application to ensure all preconditions are met before starting the exchange creation process. |
Autodesk.DataExchange.BaseModels | BaseWriteOnlyExchangeModel / BaseReadWriteExchangeModel | public virtual bool ValidateCanUpdateExchange(Dictionary<string, object> parameters, out List<string> validationErrors) | public virtual Task<IEnumerable<string>> ValidateCanUpdateExchangeAsync(Dictionary<string, object> parameters) | This method can be overridden to let the host application intercept and potentially prevent the exchange update process. It allows for checks or actions, such as prompting the user to save changes or verifying the document's suitability for an exchange update, especially if modifications have been made or other preconditions must be met. |
Autodesk.DataExchange.UI | Configuration | public Func<Task<ConnectorLatestVersionInfo>> ConnectorLatestVersionCallback { get; set; } | public Func<Task<ConnectorVersionInfo>> ConnectorLatestVersionInfoCallback { get; set; } | Gets or sets the connector defined callback which returns information. |
Autodesk.DataExchange.SDK
Namespace | Class | Old method signature | New method signature | Description |
---|---|---|---|---|
Autodesk.DataExchange | Client | public string DownloadCompleteExchangeAsSTEP(string exchangeID, string stepFilePath = null) | public string DownloadCompleteExchangeAsSTEP(DataExchangeIdentifier exchangeIdentifier, string stepFilePath = null) | Downloads whole exchange as STEP |
Autodesk.DataExchange | Client | public Task GenerateViewableAsync(string exchangeID, string collectionId, ViewableWorldCoordinates viewableWorldCoordinates = null) | public Task GenerateViewableAsync(string exchangeID, string collectionId) | Generates Data exchange in viewable format. |
Autodesk.DataExchange | Client | public Task |
public Task |
Retrieves collection using project urn. |
Autodesk.DataExchange | Client | public Task |
public Task |
Retrieves Exchange Details given a collection and an Exchange Urn. The Exchange Urn is the unique ID of the exchange on the hosting provider. For example, an ACC Hosting Provider exchangeUrn looks like this: urn:adsk.wipprod:dm.lineage:_ddmvl0URhm6EihBiPYIXQ. |
Autodesk.DataExchange.DataModels | Element | public Task CreateParameterAsync(ParameterDefinition parameterDefinition) | public Task CreateInstanceParameterAsync(ParameterDefinition parameterDefinition) | Creates instance parameter |
Autodesk.DataExchange.DataModels | Element | public void DeleteParameter(string schemaId) | public void DeleteInstanceParameter(Parameter schemaId) | Deletes instance parameter |
Autodesk.DataExchange.DataModels | Element | public void UpdateParameter(Parameter schemaId, object value) | public void UpdateInstanceParameter(Parameter schemaId, object value) | Updates existing instance parameter with specified value. |
Autodesk.DataExchange.DataModels | ElementDataModel | public IEnumerable |
public IEnumerable |
Gets a list of the top level elements within this Data Exchange. Please note that new version of sdk still contains Elements property but it returns all elements present in exchange not just top level element. |
Autodesk.DataExchange.DataModels | ElementProperties | public Matrix4d TransformationMatrix { get; set; } | public Transformation Transformation { get; set; } | This property holds a 4x4 transformation matrix that defines spatial transformations, such as translation, rotation, and scaling. |
Autodesk.DataExchange.DataModels | GeometryProperties.cs | public GeometryProperties(PrimitiveSchemas.Geometry.Geometry geometry, RenderStyle renderStyle) | public GeometryProperties(PrimitiveSchemas.Design.CurveSet curveSet, RenderStyle renderStyle) | Primitive geometry as instance of CurveSet to the constructor of GeometryProperties |
Autodesk.DataExchange.DataModels | GeometryProperties.cs | public GeometryProperties(PrimitiveSchemas.Geometry.Geometry geometry, RenderStyle renderStyle) | public GeometryProperties(PrimitiveSchemas.Design.GeometryContainer geometryContainer, RenderStyle renderStyle) | Primitive geometry as instance of GeometryContainer to the constructor of GeometryProperties |
Autodesk.DataExchange.DataModels | GeometryProperties.cs | public GeometryProperties(PrimitiveSchemas.Geometry.Geometry geometry, RenderStyle renderStyle) | public GeometryProperties(PrimitiveSchemas.Design.DesignPoint designPoint, RenderStyle renderStyle) | Primitive geometry as instance of DesignPoint to the constructor of GeometryProperties |
Autodesk.DataExchange.DataModels | ParameterDefinition | public bool IsForceCheckFSSSChemaPresent { get; set; } = true; | public bool IsCustomParameter { get; set; } | IsCustomParameter is used to understand is parameter is custom parameter or not |
Added
Here is an overview of the API’s Added items.
Autodesk.DataExchange.SDK.UI
Namespace | Class/Interface | New method/property | Description |
---|---|---|---|
Autodesk.DataExchange.UI | Application | public void ClearBusyMessage() | Clears the message and spinner on the UI and restores the previous state of the UI. |
Autodesk.DataExchange.UI | Application | public void ShowBusyMessage(string message) | Displays the provided message on the UI with a spinner. The "show busy" message refers to a state where all controls are hidden, and an animation is shown along with the user-defined message. |
Autodesk.DataExchange.SDK
Namespace | Class/Interface | New method/property | Description |
---|---|---|---|
Autodesk.DataExchange.Extensions.HostingProvider | IHostingProvider | public Task |
Retrieves hub id asynchronously using project Urn. |
Autodesk.DataExchange.Extensions.HostingProvider | IHostingProvider | public Task |
Retrieves region asynchronously using project Urn. |
Autodesk.DataExchange | IClient | public event EventHandler |
Occurs when there is an update in the progress of an exchange operation. Subscribers can use this event to receive real-time progress messages during lengthy operations like exchange creation or loading. |
Autodesk.DataExchange.DataModels | GeometryProperties | public GeometryProperties(string filePath, string format, RenderStyle renderStyle) | Used for custom geometries file format. Example: .smb, .ttmesh |
Autodesk.DataExchange | SDKOptions | ConnectorName | Gets or sets unique Connector Name. Also used to form the path for storing logs. |
Autodesk.DataExchange | SDKOptions | ConnectorRootPath | Gets or sets the connector root path. |
Autodesk.DataExchange | SDKOptions | ConnectorVersion | Gets or sets the current version of the connector. |
Autodesk.DataExchange | SDKOptions | HostApplicationName | Gets or sets the name of the hosting application. |
Autodesk.DataExchange | SDKOptions | HostApplicationVersion | Gets or sets the current version of the hosting application. |
Autodesk.DataExchange.DataModels | Element.cs | Transformation | An instance of Models.Components.Transformation that represents the current transformation of the element. |
Autodesk.DataExchange.DataModels | ElementDataModel | public Task |
Creates parameter for specified type using input parameter definition. |
Autodesk.DataExchange.DataModels | ElementDataModel | public bool DeleteTypeParameter(string type, Parameter schemaId) | Deletes type parameter from specified type for given schemaId. |
Autodesk.DataExchange.DataModels | ElementDataModel | public Dictionary |
Returns a dictionary of Types and their Parameters. If specified Type is not present in exchange data, then no parameters will be returned for it. |
Autodesk.DataExchange.DataModels | ElementDataModel | public ViewableWorldCoordinates GetViewableWorldCoordinates() | Retrieves the viewable world coordinates. |
Autodesk.DataExchange.DataModels | ElementDataModel | public void SetViewableWorldCoordinates(ViewableWorldCoordinates viewableWorldCoordinates) | Sets the world coordinates for the viewable. |
Deprecated
Here is an overview of the API’s deprecated items.
Autodesk.DataExchange.SDK.UI
Namespace | Class/Interface | Method/Property |
---|---|---|
Autodesk.DataExchange.UI | Configuration | public string ConnectorVersion { get; set; } |
Autodesk.DataExchange.UI | Configuration | public string HostingProductID { get; set; } |
Autodesk.DataExchange.UI | Configuration | public string HostingProductVersion { get; set; } |
Autodesk.DataExchange.SDK
Namespace | Class/Interface | Method/Property |
---|---|---|
Autodesk.DataExchange | SDKOptions | ApplicationName |
Autodesk.DataExchange | SDKOptions | ApplicationRootPath |
Autodesk.DataExchange.DataModels | Element.cs | public bool DeleteTypeParameter(Parameter schemaId) |
Autodesk.DataExchange.DataModels | Element.cs | public List |
Autodesk.DataExchange.DataModels | Element.cs | public bool UpdateTypeParameter(Parameter schemaId, object value) |
Autodesk.DataExchange.DataModels | Parameter | public bool IsTypeParameter { get; set; } |
Autodesk.DataExchange.DataModels | ParameterDefinition | public bool IsTypeParameter { get; set; } |
Data Exchange SDK 4.0.4
The following sections contain detailed information about the release of Data Exchange SDK 4.0.4 version:
Release information
Download and extract the zip file of Data Exchange SDK installable from the Feedback portal.
- Build name: Autodesk.DataExchange.4.0.4-beta.zip
- Date: 2024-02-28
New Features
- As part of this release, the Data Exchange SDK supports BIM360 as a hosting provider, along with ACC.
Added
- Added a new method GetCollectionAsync to the to the IClient interface.
- Added a new method CreateCollectionAsync to the to the IClient interface.
Updated
- The GenerateViewableAsync method now requires three arguments (exchangeID, collectionId, and viewableWorldCoordinates)
Deprecated
The following table contains information about deprecated methods and their corresponding alternatives in the current release:
Data Exchange SDK 3.3.1
The following sections contain detailed information about the release of Data Exchange SDK 3.3.1 version:
Release information
Download and extract the zip of Data Exchange SDK installable from the Feedback portal.
- Build name: Autodesk.DataExchange.3.3.1-beta.zip
- Date: 2023-12-21
Added
- Added a new method DownloadCompleteExchangeAsOBJ to the IClient interface. This method takes
exchangeID
,collectionId
, andobjFilePath
(optional) as arguments and returns the folder path that contains the downloaded OBJ and MTL files.
Updated
- The GenerateViewableAsync method now only requires two arguments (exchangeID and collectionId).
Deprecated
- The GenerateViewableAsync(exchangeName, exchangeID, collectionId, exchangeURN) method with four arguments is deprecated. Instead use the updated GenerateViewableAsync method which contains only two arguments.
- The Element class constructor Element(InstanceAsset asset) is deprecated. Instead use the ElementDataModel.AddElement() method to create a new Element instance.
- The ExchangeData class constructors ExchangeData() and ExchangeData(List
assetList) are deprecated. Instead, use the ElementDataModel.Create() method to create a new ExchangeData instance.
Release Date: 2023-08-31
Public beta release.
Release Date: 2023-03-30
Private beta release.