Class Widgets

Hierarchy

  • Widgets

Constructors

constructor

Properties

routeCreateWidget routeDeleteWidget routeListWidget routeSetMainImage routeSetRemoveImage routeUpdateWidget routeViewWidget routesetRemoveImage

Methods

createWidget deleteWidget getWidgets updateWidget viewWidget

Constructors

constructor

Properties

Static Private routeCreateWidget

routeCreateWidget: Route = ...

Static Private routeDeleteWidget

routeDeleteWidget: Route = ...

Static Private routeListWidget

routeListWidget: Route = ...

Static Private routeSetMainImage

routeSetMainImage: Route = ...

Static Private routeSetRemoveImage

routeSetRemoveImage: Route = ...

Static Private routeUpdateWidget

routeUpdateWidget: Route = ...

Static Private routeViewWidget

routeViewWidget: Route = ...

Static Private routesetRemoveImage

routesetRemoveImage: Route = ...

Methods

Static createWidget

  • Create a new widget add-on that can be integrated with a live event.

    See

    Widget Create Widget - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static deleteWidget

  • Deletes a widget's information.

    See

    Widget Delete Widget- BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • widget_id: string

      The id of widget.

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static getWidgets

  • Retrieves widgets.

    See

    Widget - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static updateWidget

  • Updates a widget's information.

    See

    Widget Update Widget- BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • widget_id: string

      The id of widget.

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static viewWidget

  • View the information pertaining to a single widget.

    See

    Widget View Widget - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • widget_id: string

      The id of widget.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc