The DocumentController is responsible for all communication regarding the Document. Methods inside this controller can be called by window.SDK.document.{method-name}

Methods

  • This method will create a new document, based on a document preset

    Note: This method must be called with valid authentication tokens set up (via ConfigurationController), this method WILL NOT trigger a token refresh flow if the authentication is invalid or expired

    Parameters

    • preset: LayoutPreset

      the preset where we will create a document of.

    Returns Promise<EditorResponse<null>>

    the new document created and loaded inside of the canvas

  • This method will load a provided document in the ChiliDocument format and clean old document states. If you set DocumentLoadOptions.keepConnectors to true, load will keep your old connectors states e.g. options, authentication.. By default keepConnectors is false and your connectors states are reset. In this case, you would need to configure your connectors appropriately beforehand.

    Note: This method must be called with valid authentication tokens set up (via ConfigurationController), this method WILL NOT trigger a token refresh flow if the authentication is invalid or expired

    Parameters

    Returns Promise<EditorResponse<null>>

    the document loaded inside of the canvas