UUX Payload

This Install Step is used to add a javascript file to the initial HTML payload returned by uux.aspx.

class q2_sdk.core.install_steps.uux_payload.UUXPayloadScript(url, defer_load=False, integrity=None, sdk_asset=True, wedge_address_js_variables=<factory>)

Bases: object

Dataclass used to define the scripts to be included in the uux.aspx payload. These should be passed in as a List to the UUXPayload constructor.

url: str

url if sdk_asset = False or filename (in frontend/public folder) if sdk_asset is True of the javascript file to include

defer_load: bool = False

//developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-defer

Type:

https

integrity: Optional[str] = None

//developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-integrity. Required if sdk_asset false.

Type:

https

sdk_asset: bool = True

Indicates if the file referenced by url is local to this extension

wedge_address_js_variables: list

List of WEDGE_ADDRESS_CONFIGS keys to include as variables in JS. Will be placed in window.__{extension_name} dictionary

class q2_sdk.core.install_steps.uux_payload.UUXPayload(scripts, base_override=None, **kwargs)

Bases: InstallStep

Install a JS file for inclusion in uux.aspx payload

The UUXPayload class takes a list of UUXPayloadScript objects. They will be placed sequentially into the bottom of the uux.aspx’s HTML.

Parameters:

• scripts (list[UUXPayloadScript]) – List of UUXPayloadScript objects

• base_override – value to use as the base asset url instead of using the url of the running container

async install()

Must be overridden in inherited class to work with install

async uninstall()

Must be overridden in inherited class to work with remove_form