Request

Response

    ICustomForm interface

    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.

    public interface ICustomForm
    

    Members

    namedescription
    Id { get; } Gets the unique identifier for this custom form. This identifier is used to reference and manage the form within the Connector UI.
    BuildDescriptor() Builds and returns a form descriptor that represents the current state of the custom form. This descriptor contains all the input fields and their current values, which are used by the Connector UI to render the form interface.
    GetInputContentAsync(…) Retrieves custom content for a specific input field when requested by the Connector UI. This method is called when the Connector UI needs to display rich content associated with a particular input field, such as images or other media.
    GetInputFieldsAsync(…) Retrieves the input fields to display as the contents of this custom form. This method is called when the custom form is initially displayed and after each call to HandleInputUpdatedAsync that returns true.
    HandleFormSubmissionAsync(…) Handles the final user action on the custom form, either submission or cancellation. Implementations should use this method to persist form data when the user confirms their input, or to discard changes when the user cancels.
    HandleInputUpdatedAsync(…) Handles user input updates on the custom form. This method is called when a user modifies any input field, allowing the custom form implementation to update its internal state and determine whether the form should be refreshed.

    See Also