Type alias FormElementWithOptionsBase

FormElementWithOptionsBase: LookupFormElement & FormElementRequired & FormElementReadOnly & {
    attributesMapping?: DynamicOptionsSetAttributeMap[];
    conditionallyShowOptions?: boolean;
    conditionallyShowOptionsElementIds?: string[];
    dynamicOptionSetId?: number;
    freshdeskFieldName?: string;
    options?: ChoiceElementOption[];
    optionsType: "CUSTOM" | "DYNAMIC" | "SEARCH" | "FRESHDESK_FIELD";
    requiresAllConditionallyShowOptionsPredicates?: boolean;
}

Type declaration

  • Optional attributesMapping?: DynamicOptionsSetAttributeMap[]

    Used to map an attribute from a dynamic options source with an option element ID within the form definition

  • Optional conditionallyShowOptions?: boolean

    Whether or not the element's options are to be shown conditionally.

  • Optional conditionallyShowOptionsElementIds?: string[]

    The ID(s) of elements which will filter the each option to be conditionally displayed. An option can only be filtered by another element's options

  • Optional dynamicOptionSetId?: number

    The ID of the dynamic options set configured in the OneBlink System.

  • Optional freshdeskFieldName?: string
  • Optional options?: ChoiceElementOption[]

    An array of options, relevant to the element.

    Each option must have an id property that contains a universally unique identifier (UUID). The identifier must be a Version 4 (V4) UUID and must conform to the formatting requirements defined in this RFC 9562 specification: https://www.rfc-editor.org/rfc/rfc9562.html

  • optionsType: "CUSTOM" | "DYNAMIC" | "SEARCH" | "FRESHDESK_FIELD"

    Whether or not the options set is defined within the form definition (custom), or via an API call (dynamic OR search).

  • Optional requiresAllConditionallyShowOptionsPredicates?: boolean

    Whether or not all the predicates must match for the options to be shown (true) or if only one needs to match (false).

Settings

Theme