Disclaimer

class q2_sdk.core.install_steps.disclaimer.Disclaimer(display_name, corresponding_form_shortname, short_name='', ui_text_elem_shortname=None, disclaimer_type='', **kwargs)[source]

Bases: InstallStep

Interacts with the Q2_Disclaimer, Q2_DisclaimerBundle, Q2_DisclaimerBundleToGroup, Q2_DisclaimerFormData and Q2_DisclaimerElement tables

Creates both Logon and Interface disclaimers

Parameters:

  • display_name (str) – Title displayed on the disclaimer

  • corresponding_form_shortname (str) – Q2_Form.short_name association

  • short_name – Q2_Disclaimer.short_name. Defaults to ‘FormDisclaimer_{corresponding_form_shortname}’

  • ui_text_elem_shortname (Optional[str]) – Defaults to ‘Disclaimer: {short_name}’

  • disclaimer_type – ‘Logon’ has special meaning, otherwise leave blank to use this disclaimer’s short_name

async install()[source]

Must be overridden in inherited class to work with install

async uninstall()[source]

Must be overridden in inherited class to work with remove_form