From Bright Pattern Documentation

Revision as of 01:44, 3 April 2026 by Laura.donovan (talk | contribs) (Updated via BpClonePage extension. Source page: draft:AgentDesktop-client-side-javascript-api-specification/setWidgetMinimized)

< Previous | Next >
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

setWidgetMinimized

Enables or disables the Communicator Widget’s minimized state. Set the parameter value true to minimize the widget or false to restore it back to its normal size.

Request

Syntax

setWidgetMinimized(minimized: boolean): Promise<OperationResult<null>>

Parameters

Parameter Parameter Values Data Type Optional/Required Description
minimized Boolean Required Set the parameter value true to minimize the widget or false to restore it back to its normal size.

Example Request

    setWidgetMinimizedButton.onclick = () => {

        const widgetMinimized = widgetMinimizedCheckbox.checked

        adApi.setWidgetMinimized(widgetMinimized)

    }

Return Value

null

< Previous | Next >