Client class
This component grants access to the Data Exchange functionality, offering methods for retrieving and updating both data and metadata associated with Data Exchanges.
public class Client : IClient
Public Members
| name | description |
|---|---|
| Client(…) | |
| EventsController { get; set; } | |
| PlatformAttributes { get; set; } | General purpose additional information about exchange. |
| SDKOptions { get; } | Provides options to configure DX SDK |
| 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 a new Exchange(takes in a user-friendly name, unique identifier) and returns the Exchange creation information |
| DownloadCompleteExchangeAsOBJ(…) | Download whole exchange as OBJ |
| DownloadCompleteExchangeAsSTEP(…) | Download whole exchange as STEP |
| EnableHttpDebugLogging() | Enables logging all HTTP messages for debugging. |
| GenerateViewableAsync(…) | Generate Data exchange in viewable format. |
| GetCollectionAsync(…) | Get collection |
| GetCollectionIdAsync(…) | Get collection using project urn |
| GetExchangeDataAsync(…) | Retrieves Exchange Data for the given DataExchangeIdentifier This returns the complete data upto the latest revision. (3 methods) |
| GetExchangeDetailsAsync(…) | Get Exchange Details by the Exchange Identifier (3 methods) |
| GetExchangeRevisionsAsync(…) | Retrieves the list of Exchange Revisions for a given Exchange. |
| 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(…) | Updates a given ExchangeData object with the latest or specific revision, if updates are available. |
| SyncExchangeDataAsync(…) | Update exchange data. |
| static AssemblyResolve { get; set; } |
See Also
- interface IClient
- namespace Autodesk.DataExchange
