@japofc/baileys - v2.4.7
    Preparing search index...

    Class A2UI

    A2UI/Bloks widget builder.

    JAP@Fix (§2.37 / v2.4.7): this block previously documented the class as "fluent" and typed every component factory as returning this. At runtime they return the generated component id string (siblings reference each other by id -- that's the whole point of the API), so ui.text('a').text('b') type-checked and then died with "ui.text(...).text is not a function", while the correct const id = ui.text('a') was flagged as a type error. Factories are typed string now; only the terminal/config methods (root/listCard/setVersion/...) chain.

    Index
    • Parameters

      • url: string
      • Optionaloptions: { id?: string; size?: number; variant?: string }

      Returns string

    • Parameters

      • childId: string
      • Optionaloptions: { id?: string; label?: string }

      Returns string

    • Parameters

      • childId: string
      • Optionaloptions: {
            action?: { args?: Record<string, any>; call: string };
            id?: string;
            variant?: string;
        }

      Returns string

    • Parameters

      • childId: string
      • Optionaloptions: { id?: string }

      Returns string

    • Parameters

      • label: string
      • Optionaloptions: { id?: string; value?: boolean }

      Returns string

    • Parameters

      • label: string
      • options: { label: string; value: string }[]
      • Optionalopts: {
            displayStyle?: string;
            filterable?: boolean;
            id?: string;
            value?: string;
            variant?: string;
        }

      Returns string

    • Drop every component, the root selection and any listCard payload.

      Returns this

    • Parameters

      • Optionalchildren: string[]
      • Optionaloptions: { id?: string }

      Returns string

    • How many components are registered (excluding the implicit root).

      Returns number

    • Parameters

      • Optionaloptions: { id?: string }

      Returns string

    • Registered components nothing references -- encoded but never rendered.

      Returns string[]

    • A copy of the registered component node.

      Parameters

      • id: string

      Returns Record<string, any> | undefined

    • Whether id was registered on this instance.

      Parameters

      • id: string

      Returns boolean

    • Parameters

      • url: string
      • Optionaloptions: { fit?: string; id?: string; variant?: string }

      Returns string

    • Parameters

      • Optionalchildren: string[]
      • Optionaloptions: { id?: string }

      Returns string

    • Parameters

      • triggerId: string
      • contentId: string
      • Optionaloptions: { id?: string }

      Returns string

    • Parameters

      • value: number
      • Optionaloptions: { id?: string; max?: number; min?: number; variant?: string }

      Returns string

    • Parameters

      • component: string
      • Optionalprops: Record<string, any>
      • Optionaloptions: { id?: string }

      Returns string

    • Unregister one component; returns whether it existed.

      Parameters

      • id: string

      Returns boolean

    • Parameters

      • Optionalchildren: string[]
      • Optionaloptions: { id?: string }

      Returns string

    • Parameters

      • client: any
      • jid: string
      • Optionalopts: Record<string, any>

      Returns Promise<any>

    • Override the catalog url used in createSurface.catalogId.

      Parameters

      • catalogId: string

      Returns this

    • Override the A2UI spec version stamped on the payload.

      Parameters

      • version: string

      Returns this

    • Parameters

      • Optionaloptions: {
            id?: string;
            label?: string;
            max?: number;
            min?: number;
            step?: number;
            value?: number;
        }

      Returns string

    • Parameters

      • Optionaloptions: { height?: number; id?: string }

      Returns string

    • Parameters

      • label: string
      • Optionaloptions: { id?: string; value?: boolean }

      Returns string

    • Parameters

      • Optionalchildren: string[]
      • Optionaloptions: { activeTab?: number; id?: string }

      Returns string

    • Parameters

      • text: string
      • Optionaloptions: { id?: string; variant?: string }

      Returns string

    • Parameters

      • label: string
      • Optionaloptions: { id?: string; variant?: string }

      Returns string

    • Every structural problem; empty when the widget is safe to build.

      Returns string[]

    • Parameters

      • url: string
      • Optionaloptions: { id?: string }

      Returns string