Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetStore

The WidgetStore class provides access to data and status of active plug-ins; Provides direct access to the WidgetController instance; Provides plugin-related apis for activating, deactivating, and updating the status of plugins.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

widgetController

Methods

addWidgetStateListener

deleteWidget

  • deleteWidget(widgetId: string): undefined | Promise<{ data: any }>

  • delete the widget

    Parameters

    • widgetId: string

      widget ID

    Returns undefined | Promise<{ data: any }>

onDestroy

  • onDestroy(): void

onInstall

  • onInstall(): void

removeWidgetExtra

  • removeWidgetExtra(widgetId: string, keys?: string[]): undefined | Promise<{ data: any }>

  • delete the extra properties of the widget

    Parameters

    • widgetId: string

      widget ID

    • Optional keys: string[]

    Returns undefined | Promise<{ data: any }>

removeWidgetStateListener

removeWidgetUserProperties

  • removeWidgetUserProperties(widgetId: string, keys?: string[]): undefined | Promise<{ data: any }>

  • delete user private properties of the widget

    Parameters

    • widgetId: string

      widget ID

    • Optional keys: string[]

    Returns undefined | Promise<{ data: any }>

setActive

  • setActive(widgetId: string, widgetProps?: any, ownerUserUuid?: string): void

  • Set widget state to active

    Parameters

    • widgetId: string

      widget ID

    • Optional widgetProps: any

      widget props

    • Optional ownerUserUuid: string

    Returns void

setInactive

  • setInactive(widgetId: string, widgetProps?: any): void

  • Set widget state to inactive

    Parameters

    • widgetId: string

      widget ID

    • Optional widgetProps: any

      widget props

    Returns void

updateWidgetProperties

  • updateWidgetProperties(widgetId: string, widgetProps?: any): undefined | Promise<{ data: any }>

  • Parameters

    • widgetId: string
    • Optional widgetProps: any

    Returns undefined | Promise<{ data: any }>

updateWidgetUserProperties

  • updateWidgetUserProperties(widgetId: string, widgetProps?: any): undefined | void

  • Parameters

    • widgetId: string
    • Optional widgetProps: any

    Returns undefined | void