IClient interface
The IClient interface represents the contract for the Autodesk.DataExchange It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the Autodesk.DataExchange.OpenAPI. The specific methods and members defined within the IClient interface may vary based on the requirements and capabilities of the Autodesk.DataExchange implementation.They typically include operations for data retrieval, data update, metadata management, error handling, and other relevant functionalities related to Data Exchanges.
public interface IClient
Members
| name | description |
|---|---|
| event ProgressUpdated | 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. If the Connector UI is present, it will update its progress screen in response to this event, displaying progress messages to the user. This event is primarily used internally by the SDK to provide feedback to its UI during lengthy operations. |
| event ViewableGenerationCompleted | An event is triggered when the completion of viewable generation is marked as failed or completed. |
| event ViewableGenerationStarted | An event is triggered at the beginning of the viewable generation process. |
| CreateCollectionAsync(…) | Create collection |
| CreateExchangeAsync(…) | Create exchange async. |
| DownloadCompleteExchangeAsOBJ(…) | Download whole exchange as OBJ |
| DownloadCompleteExchangeAsSTEP(…) | Download whole exchange as STEP |
| GenerateViewableAsync(…) | |
| GetCollectionIdAsync(…) | Get collection using Project Urn. Hub id is optional here.If you provide hub id then it will use region based routing for API call. |
| GetExchangeDataAsync(…) | Get exchange data async (3 methods) |
| GetExchangeDetailsAsync(…) | Get exchange by id async. (2 methods) |
| GetExchangeRevisionsAsync(…) | Get exchange revisions async |
| GetHubIdAsync(…) | Get Hub Id using Project Urn. |
| NotifyProgressUpdated(…) | Sends a progress update message to all subscribers. This method raises the ProgressUpdated event and sends the progress message to the registered listeners. |
| RetrieveLatestExchangeDataAsync(…) | Retrieve updates from the Data Exchange |
| SyncExchangeDataAsync(…) | Update exchange data. |
See Also
- namespace Autodesk.DataExchange.Interface
