IInteropBridge interface
Defines the interface through which the host application launches and interacts with the Connector UI process.
public interface IInteropBridge
Members
| name | description |
|---|---|
| ClientConnected { get; } | Gets a value indicating whether the Connector UI process is running and connected to the UI Bridge. |
| Initialized { get; } | Gets a value indicating whether the UI Bridge has been initialized successfully. When initialized, the bridge is actively listening for incoming connections from the Connector UI process, although the Connector UI process may not be running. |
| Invoker { get; } | Gets the main thread invoker for the host application. Through this invoker, the UI Bridge can execute asynchronous operations on the main thread of the host application. See IMainThreadInvoker for detailed information. |
| UiWindowHandle { get; } | Gets the window handle of the Connector UI process. Returns Zero if the Connector UI process is not currently running. |
| event ClientStateChanged | Occurs when a client connects to or disconnects from the UI Bridge. |
| event ExchangeOperationCompleted | Occurs after an exchange operation (Create, Load, Update, or Delete) has fully completed. At the point this event fires, the SDK has finished processing (including cleanup such as StopSession and SkippedElements) and the response has been delivered to the Connector UI process. This event is not raised for non-exchange messages (e.g. GetAccessToken). |
| event MessageStateChanged | Occurs when a message is received from the Connector UI process or when a message has been processed and is ready to be sent back to the Connector UI process. |
| event ServerStateChanged | Occurs when the UI Bridge begins listening for incoming connections from the Connector UI process. |
| DestroyAsync() | Closes the Connector UI process, terminates all active server connections, and releases all associated resources. |
| InitializeAsync() | Initializes the UI Bridge without launching the Connector UI process. This method prepares the Connector SDK for communication with the Connector UI process by starting the listening server. This method must be called before any other operations on the UI Bridge. |
| InvalidateCustomForm(…) | Notifies the Connector UI process to refresh the specified custom form. This triggers the form's GetInputFieldsCoreAsync method to be called again, allowing the connector to provide updated form content for display in the Connector UI. |
| LaunchConnectorUiAsync() | Launches the Connector UI process and displays the Connector UI. This method can only be called after InitializeAsync has completed successfully. |
| RefreshExchangeList() | Notifies the Connector UI process to refresh the exchange list. |
| SendNotification(…) | Sends a notification message to display in the Connector UI. |
| SetApplicationMode(…) | Changes the application mode at runtime. This method requires the connector's exchange model to implement both IExchangeReader and IExchangeWriter (i.e. the connector was initialized in ReadWrite mode). When called on a connector that only supports one mode, an InvalidOperationException is thrown. |
| SetDocumentName(…) | Sets the name of the current document to display in the Connector UI. |
| SetExchangeName(…) | Sets the display name of the current exchange in the Connector UI. The specified name will appear on the exchange creation screen. |
| SetWindowState(…) | Sets the display state of the Connector UI window. |
| UpdateProgressStep(…) | Notifies the UI about the progress of a specific step during an exchange operation. |
See Also
- namespace Autodesk.DataExchange.UI.Core.Interfaces