Request

Response

    Autodesk.DataExchange.UI.Bridge assembly

    Autodesk.DataExchange.UI.Core namespace

    public typedescription
    class BaseHostDataProvider Provides a base implementation of IHostDataProvider. Hosts can derive from this class and override its methods to supply customized data to the Connector UI when requested.
    class ConnectorVersionInfo Class to represent version information of a Connector.
    class ExchangeUpdatesPoller Provides an implementation of IExchangeUpdatesPoller for polling and notifying about exchange updates.
    class FeatureCapabilities Represents the set of capabilities that the connector host declares as supported for the Connector UI. These values are passed to the UI process and control which features are enabled or disabled.
    static class InteropBridgeFactory A factory class for creating an instance of IInteropBridge.
    class InteropBridgeOptions Represents an object that carries information to initialize the InteropBridge.

    Autodesk.DataExchange.UI.Core.Enums namespace

    public typedescription
    enum ExchangeOperationType Represents the type of exchange operation that was completed.
    enum MessageState Enum representing the state of a message, used in !:MessageStateChangedEventArgs.
    enum Severity Represents severity values to be used with the IInteropBridge.SendNotification method.
    static class SeverityUtils Provides utility methods for the Severity enum.
    enum WindowState Represents state values to be used with the !:IInteropBridge!:IInteropBridge.SetWindowState(string) method.

    Autodesk.DataExchange.UI.Core.EventArgs namespace

    public typedescription
    class ClientStateChangedEventArgs Represents the event data for the event that is triggered when the UI process connects to or disconnects from the IInteropBridge. A disconnection can occur either due to the UI process being closed by the user or as a result of an error.
    class ExchangeOperationCompletedEventArgs Represents the event data for the event that is raised when an exchange operation (such as Create, Load, Update, or Delete) has fully completed. At the point this event fires, the SDK has finished processing and the response has been delivered to the Connector UI process.
    class MessageStateChangedEventArgs Represents the event data for the IInteropBridge.MessageStateChanged event.
    class ProgressUpdateListener
    class ServerStateChangedEventArgs Represents the event data for the IInteropBridge.ServerStateChanged event.

    Autodesk.DataExchange.UI.Core.Interfaces namespace

    public typedescription
    interface IExchangeUpdatesPoller Defines a contract for polling and notifying about updates to data exchanges.
    interface IHostDataProvider Provides an optional interface for the host application to supply data to the Connector UI upon request. Implementing this interface allows the host application to provide specific data (such as exchange names) to the Connector UI, overriding the default behavior.
    interface IInteropBridge Defines the interface through which the host application launches and interacts with the Connector UI process.
    interface IMainThreadInvoker Enables asynchronous operations to be executed on the main thread of the host application. This interface must be implemented by the connector developer using host-specific APIs. It provides the UI Bridge with a way to schedule tasks that need to run on the host's main thread - typically for operations like UI updates that require thread affinity.

    Autodesk.DataExchange.UI.CustomForm namespace

    public typedescription
    abstract class BaseCustomForm Provides a base implementation for custom forms that can be displayed in the Connector UI. This abstract class implements the ICustomForm interface and provides common functionality for managing input descriptors and form lifecycle operations. Derived classes should override the abstract methods to provide custom form behavior.
    abstract class BaseCustomFormFactory
    class CustomInputContent Represents custom input content that can be displayed in the Connector UI. This class encapsulates binary content along with its MIME type, enabling custom forms to provide rich content such as images or other media to be displayed within form inputs.

    Autodesk.DataExchange.UI.CustomForm.Descriptors namespace

    public typedescription
    class AlertDescriptor Represents a descriptor for alert input elements in custom forms. This class extends BaseInputDescriptor to provide alert-specific functionality such as severity levels, visual variants, and optional links. Alert descriptors are used to display persistent informational messages, warnings, or errors to users as inline components within the custom form. The alert appears in the order specified by its position in the input descriptor list and serves as a visual note that remains visible throughout the form interaction.
    class BaseInputDescriptor Provides a base implementation of the IInputDescriptor interface. This class serves as the foundation for all input descriptor implementations, providing common properties and functionality that can be inherited by specific input types.
    class CheckboxDescriptor Represents a descriptor for checkbox input elements in custom forms. This class extends BaseInputDescriptor to provide checkbox-specific functionality such as managing the checked state. Checkbox descriptors are used to create interactive checkbox components that allow users to select or deselect options within custom forms.
    class DataMappingDescriptor Provides an implementation of the IDataMappingDescriptor interface for creating data mapping components in custom forms. This descriptor enables users to map source values to target values.
    class FormDescriptor Provides a concrete implementation of the IFormDescriptor interface. This class serves as a container for multiple input descriptors, enabling the creation of custom form with input elements on the Connector UI. The FormDescriptor is serialized and sent to the Connector UI process for display, where input fields are created based on its list of InputDescriptor objects. Unlike other IInputDescriptor derived classes, this class is for internal use only and is handled by BaseCustomForm. Connector developers do not need to use this class directly.
    class ImageViewerDescriptor Provides a descriptor implementation for image viewer input elements in custom forms. This class extends BaseInputDescriptor to include image-specific functionality such as image hash management and display height constraints. Image viewer descriptors are used to render image viewer components in the Connector UI. When an image needs to be displayed, the UI invokes ICustomForm.GetInputContentAsync to retrieve the image content in binary form. This content is cached after the initial request and only re-fetched when the ImageHash value changes. If the same hash is returned, the UI assumes the image is unchanged and avoids redundant requests.
    class LabeledOption Represents a selectable option within a dropdown/selector component in custom forms. Each option contains an identifier, display label, and optional tooltip text to provide users with clear information about the available choices in the selector.
    class SelectorDescriptor Provides an implementation of the ISelectorDescriptor interface for creating dropdown/selector input components in custom forms. This descriptor enables users to select from a predefined list of options, supporting both single and multiple selection modes. The selector will render as a dropdown list in the Connector UI.
    class TextFieldDescriptor Provides an implementation of the ITextFieldDescriptor interface for creating text input components in custom forms. This descriptor enables users to enter text-based data with support for various input types and can be configured as single or multi-line input.
    class TypographyDescriptor Provides an implementation of the ITypographyDescriptor interface for creating text display components in custom forms. This descriptor enables customizable text styling, alignment, and formatting options for displaying static or dynamic text content.

    Autodesk.DataExchange.UI.CustomForm.Enums namespace

    public typedescription
    static class AlertColor Provides constants for alert severity colors used in custom forms. These colors determine the visual styling and semantic meaning of alert components. This class is specifically used with !:AlertDescriptor to define the severity level of alert elements.
    static class AlertVariant Provides constants for alert visual variants used in custom forms. These variants determine the styling approach and visual appearance of alert components.
    static class CustomFormId Represents the IDs of custom forms built into the Connector UI. These IDs are used as arguments for the ICustomFormFactory.CreateAsync method to instantiate specific forms.
    static class InputType Defines constants for input component types used in custom forms. These values indicate the type of input element to be created on the form within the Connector UI. This class is intended for internal use only; connector developers should not need to reference it.
    static class MimeType Provides constants for MIME type values used in custom forms. These values specify the content type of data being generated and are intended for use with CustomInputContent when returning content from the !:ICustomForm.GetInputContentAsync method.
    static class TextFieldType Provides predefined text field type constants for use with text input components in custom forms. These constants define the HTML input types and validation behaviors that can be applied to text fields, ensuring consistent input handling and appropriate user interface rendering. Use these values when setting the TextFieldType property of TextFieldDescriptor.
    static class TypographyAlign Provides constants for text alignment options used in typography components. These values control how text is horizontally aligned within its container.
    static class TypographyVariant Provides constants for typography variant options used in typography components. These values control the visual style, size, and weight of text elements, ranging from large headings to small caption text with various font weights.

    Autodesk.DataExchange.UI.CustomForm.Interfaces namespace

    public typedescription
    interface IAlertDescriptor Represents an interface for alert input descriptors in custom forms. This interface extends IInputDescriptor to define alert-specific properties such as severity levels and visual variants. Alert descriptors are used to display persistent informational messages, warnings, or errors as inline components within custom forms.
    interface ICheckboxDescriptor Represents an interface for checkbox input descriptors in custom forms. This interface extends IInputDescriptor to define checkbox-specific properties such as the checked state. Checkbox descriptors are used to create interactive checkbox components that allow users to select or deselect options.
    interface ICustomForm Defines the interface for custom forms that can be displayed in the Connector UI. Custom forms provide a way for host applications to present interactive user interfaces within the Connector UI, allowing for data collection, configuration, and user interaction beyond the standard exchange creation workflow.
    interface ICustomFormFactory Defines the factory interface for creating custom forms. This interface is provided to the InteropBridgeFactory.Create API during the initialization of the Connector UI, which uses it to instantiate custom forms as required. Refer to the CustomFormId class for scenarios in which custom forms may be requested.
    interface IDataMappingDescriptor Represents the interface for DataMappingDescriptor custom form. This interface defines properties specific to DataMappingDescriptor class.
    interface IExchangeContextForm Opt-in capability interface that extends ICustomForm for forms that require exchange metadata. Implement this interface instead of adding ICustomForm separately — it already extends it. Use when the form needs to inspect application-category attributes from the selected exchange (e.g. connector name, source application version) before rendering its input fields. The UI Bridge calls ApplyExchangeContext once per form session, immediately before GetInputFieldsAsync is invoked.
    interface IFormDescriptor Represents an interface for form descriptors in custom forms. This interface extends IInputDescriptor to define form-specific properties for internal serialization and UI communication. Form descriptors serve as containers for input descriptor collections that get serialized and sent to the Connector UI process for display. This interface is intended for internal use only and is not directly used by Connector developers.
    interface IImageViewerDescriptor Defines an interface for image viewer input descriptors used in custom forms. This interface extends IInputDescriptor to include image-specific properties such as the image hash and maximum display height. Image viewer descriptors are used to render image viewer components in the Connector UI. When an image needs to be displayed, the UI invokes ICustomForm.GetInputContentAsync to retrieve the image content in binary form. This content is cached after the initial request and only re-fetched when the ImageHash value changes. If the same hash is returned, the UI assumes the image is unchanged and avoids redundant requests.
    interface IInputDescriptor Represents the base interface for all input descriptors used in custom forms. This interface defines common properties shared by all form input elements, and is designed for serialization when communicating with the Connector UI process.
    interface ISelectorDescriptor Represents the interface for selector input descriptors used in custom forms. This interface defines properties specific to dropdown/selector components that allow users to select from a list of predefined options. The selector can be configured for single or multiple selection modes and will render as a dropdown list in the Connector UI.
    interface ITextFieldDescriptor Represents the interface for text field input descriptors used in custom forms. This interface defines properties specific to text input components that allow users to enter text-based data. The text field can be configured for different input types and supports single-line and multi-line text input.
    interface ITypographyDescriptor Represents the interface for typography descriptors used in custom forms. This interface defines properties specific to text display components that allow for customizable text styling, alignment, and formatting.

    Autodesk.DataExchange.UI.TestHarness namespace

    public typedescription
    class ConnectorAPI The ConnectorAPI class provides a UI-related functionalities such as exchange create, update, delete, etc.

    Autodesk.DataExchange.BaseModels namespace

    public typedescription
    abstract class BaseExchangeModel This base class provides basic Data Exchange capabilities which are required in common for models that intend to read to or write from a Data Exchange. It serves as a foundation for building upon these features.
    abstract class BaseReadOnlyExchangeModel This base class provides essential read-only exchange capabilities while offering additional functionalities such as data caching and logging. It serves as a foundation for building upon these features.
    abstract class BaseReadWriteExchangeModel 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.
    abstract class BaseWriteOnlyExchangeModel This base class provides essential write only exchange capabilities while offering additional functionalities such as data caching and logging. It serves as a foundation for building upon these features.

    Autodesk.DataExchange.UI.Helper namespace

    public typedescription
    static class ExchangeUrl