BaseReadWriteExchangeModel class
This base class provides essential read and write exchange capabilities while offering additional functionalities such as data caching and logging. It serves as a foundation for building upon these features.
public abstract class BaseReadWriteExchangeModel : BaseExchangeModel, IExchangeReader,
IExchangeWriter
Public Members
| name | description |
|---|---|
| BaseReadWriteExchangeModel(…) | Initializes a new instance of BaseReadWriteExchangeModel |
| override Client { get; protected internal set; } | Instance of Autodesk.DataExchange. |
| event AfterCreateExchange | Event should be invoked after the create exchange. |
| event AfterGetLatestExchangeDetails | Event should be invoked After the get latest exchange details. |
| event BeforeCreateExchange | Event should be invoked Before the create exchange. |
| event BeforeGetLatestExchangeDetails | Event should be invoked Before the get latest exchange details. |
| override event ExchangeUpdated | The event will trigger when pubnub returns data stating exchange got updated. |
| event GetLatestExchangeDetails | Event should be invoked to get the latest exchange details |
| event ViewableGenerationCompleted | The event will trigger when viewable generation is completed.It can be either failed or successful. The result of viewable generation is sent by event parameter. |
| event ViewableGenerationStarted | The event will trigger when viewable generation is started. |
| virtual CreateExchangeAsync(…) | It will create exchange as per exchange inputs and provide instance of DataExchange. |
| virtual DeleteExchangeAsync(…) | It will delete data exchange. |
| virtual GetExchangeAsync(…) | Retrieve an instance of data exchange by exchange identifier(CollectionId and ExchangeId). |
| virtual GetValidExchangesAsync(…) | It will validate exchanges for parent folder deletion, folder location change, etc on hosting provider. |
| virtual OnGetLatestExchangeDataAction(…) | Triggers BeforeGetExchange,GetExchangeDetails and AfterGetExchange event handlers to get the latest details for exchange. |
| abstract UnloadExchangesAsync(…) | To delete loaded exchange from the UI and remove entities from the platform application. |
| abstract UpdateExchangeAsync(…) | Update the Exchange. Upload the view information. |
| virtual ValidateCanCreateExchangeAsync() | Asynchronously validates whether the creation of an exchange can proceed. This method can be overridden by the host application to perform necessary checks or validations, ensuring that all preconditions are met before the exchange creation process begins. |
| virtual ValidateCanUpdateExchangeAsync(…) | This method can be overridden to allow the host application to intercept and potentially prevent the exchange update process. It provides an opportunity to perform checks or actions, such as prompting the user to save changes or verifying that the current document is in a suitable state for an exchange update. This is particularly useful if modifications have been made to the document or if other preconditions must be met before continuing with the update process. |
| virtual ValidateGetLatestExchangeAsync() | It will validate load exchange action. The validation is completely depends on platform application. |
| virtual ValidateGetLatestExchangeDetailsAsync() | It will verify the prerequisites for the latest exchange details. I should be executed before GetLatestExchangeDetailsAsync and according the status further method should be executed. The validation is completely depends on platform applications. |
See Also
- class BaseExchangeModel
- namespace Autodesk.DataExchange.BaseModels
