Request

Response

    InteropBridgeOptions class

    Represents an object that carries information to initialize the InteropBridge.

    public class InteropBridgeOptions
    

    Public Members

    namedescription
    InteropBridgeOptions() The default constructor.
    static FromClient(…) Constructs an InteropBridgeOptions instance using the specified IClient object. This method provides a convenient way to initialize an InteropBridgeOptions instance based on an existing IClient, eliminating the need to manually set its properties.
    Auth { get; set; } Gets or sets the IAuth object that contains information of the authenticated user. It will also be used to get/refresh the access token of the user for operations such as browsing for project locations in which to create the exchange.
    ConnectorName { get; set; } Gets or sets the name of the connector. This name is displayed on relevant UI elements, and can also be used in logging to identify the connector.
    ConnectorRootPath { get; set; } Gets or sets the connector root path.
    ConnectorVersion { get; set; } Gets or sets the version of the connector. This version is displayed on relevant UI elements, and can also be used in logging to identify the connector.
    ContactSupportUrl { get; set; } Gets or sets the URL or mailto link for the Contact Support action in the connector UI. When set to an https URL, the UI opens it in the default browser. When set to a mailto link, the UI opens the default mail client. If not specified, defaults to the Data Exchange team support email.
    CustomFormFactory { get; set; } Gets or sets the factory used to create custom forms for specific screens when the Connector UI requests them. If not provided, a default implementation returns null for all custom form operations.
    Environment { get; set; } Gets or sets the environment in which the connector is launched. This property determines the runtime environment for the connector. The environment setting impacts configurations, endpoints, and other environment-specific behaviors.
    EventsController { get; set; } Gets or sets the client-supplied IEventsController object. This object facilitates the management of subscriptions to exchange updates, providing methods and events for this purpose. The connector UI uses this object to handle subscriptions and to receive notifications when an exchange is updated.
    Exchange { get; set; } Gets or sets the host-implemented exchange object. This object represents the data model through which details of an exchange or a list of exchanges can be retrieved.
    FeatureCapabilities { get; set; } Gets or sets the feature capabilities that the connector host declares as supported for the Connector UI. These values control which features are enabled or disabled.
    FeatureFlagController { get; set; } Gets or sets the client-supplied IFeatureFlagController object. This object facilitates checking for flag status to do conditional operations based on feature flags.
    FeedbackUrl { get; set; } Gets or sets the URL of the feedback page for the connector. This URL is used when the user clicks on the feedback link in the connector UI.
    HostApplicationName { get; set; } Gets or sets the name of the host product.
    HostApplicationVersion { get; set; } Gets or sets the version of the host product.
    HostDataProvider { get; set; } Gets or sets the IHostDataProvider instance used to handle UI callbacks and retrieve data from the Connector. If not set, a default implementation will be used.
    HostingProvider { get; set; } Gets or sets the hosting provider object through which the connector performs operations such as getting details of an existing exchange.
    HostWindowHandle { get; set; } Gets or sets the handle of the host window. This handle is used to parent the connector UI window to the host window. Setting this will ensure that the connector UI window is always on top of the host window, and that the connector UI window minimizes, maximizes and closes along with the host window.
    Invoker { get; set; } Gets or sets the host-implemented IMainThreadInvoker object. See IMainThreadInvoker for details.
    Logger { get; set; } Gets or sets the centralized logger object that is used to log messages during the execution of the connector.
    UpdateCheckFrequency { get; set; } Gets or sets the update check frequency in seconds.

    See Also