Class Templates

Hierarchy

  • Templates

Constructors

constructor

Properties

routeAddWidget routeCreateTemplate routeDeleteTemplate routeGetOptionsWidget routeListTemplate routeListWidgets routeRemoveWidget routeSaveEventToTemplate routeSetOptionsWidget routeTemplateAddWidget routeTemplateGetWidgets routeTemplateRemoveWidget routeTemplateSeMainImage routeTemplateSetBackgroundImage routeTemplateSetOverlayImage routeTemplateSetWatermarkImage routeTemplateSetWidgetPositioningOptions routeTemplateUpdateWidget routeUpdateTemplate routeUpdateTemplateDesign routeUpdateWidget routeViewTemplate

Methods

addWidget createTemplate deleteTemplate deleteWidget getTemplates getWidgetPositioningOption getWidgets saveEventToTemplate setWidgetPositioningOption updateTemplate updateTemplateDesign updateWidget viewTemplate

Constructors

constructor

Properties

Static Private routeAddWidget

routeAddWidget: Route = ...

Static Private routeCreateTemplate

routeCreateTemplate: Route = ...

Static Private routeDeleteTemplate

routeDeleteTemplate: Route = ...

Static Private routeGetOptionsWidget

routeGetOptionsWidget: Route = ...

Static Private routeListTemplate

routeListTemplate: Route = ...

Static Private routeListWidgets

routeListWidgets: Route = ...

Static Private routeRemoveWidget

routeRemoveWidget: Route = ...

Static Private routeSaveEventToTemplate

routeSaveEventToTemplate: Route = ...

Static Private routeSetOptionsWidget

routeSetOptionsWidget: Route = ...

Static Private routeTemplateAddWidget

routeTemplateAddWidget: Route = ...

Static Private routeTemplateGetWidgets

routeTemplateGetWidgets: Route = ...

Static Private routeTemplateRemoveWidget

routeTemplateRemoveWidget: Route = ...

Static Private routeTemplateSeMainImage

routeTemplateSeMainImage: Route = ...

Static Private routeTemplateSetBackgroundImage

routeTemplateSetBackgroundImage: Route = ...

Static Private routeTemplateSetOverlayImage

routeTemplateSetOverlayImage: Route = ...

Static Private routeTemplateSetWatermarkImage

routeTemplateSetWatermarkImage: Route = ...

Static Private routeTemplateSetWidgetPositioningOptions

routeTemplateSetWidgetPositioningOptions: Route = ...

Static Private routeTemplateUpdateWidget

routeTemplateUpdateWidget: Route = ...

Static Private routeUpdateTemplate

routeUpdateTemplate: Route = ...

Static Private routeUpdateTemplateDesign

routeUpdateTemplateDesign: Route = ...

Static Private routeUpdateWidget

routeUpdateWidget: Route = ...

Static Private routeViewTemplate

routeViewTemplate: Route = ...

Methods

Static addWidget

  • Add a widget to the template and set which user roles will have access to the widget.

    See

    Templates Add Widgets - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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 createTemplate

  • Create a template that can used for live events.

    See

    Templates Create Template - 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 deleteTemplate

  • View a single template that been created.

    See

    Templates Delete Template - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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

  • Removes the widget from the template, and this will cause the widget to be removed from the screen.

    See

    Templates Remove Widgets - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • widget_id: string

      The id of widget.

    • Optional data: null | 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 getTemplates

  • Retrieves template data related to account.

    See

    Templates - 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 getWidgetPositioningOption

  • Return a list of configured options for the current template.

    See

    Templates Get Widget Position Options - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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 data for widgets for templates.

    See

    Templates Widgets - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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 saveEventToTemplate

  • Saves template for future events.

    Todo

    Needs documentation.

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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 setWidgetPositioningOption

  • Sets position in the option selected

    See

    Templates Set Widget Position Options - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • option_id: string

      The id of option.

    • 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 updateTemplate

  • View a single template that been created.

    See

    Templates Update Template - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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 updateTemplateDesign

  • Updates design of template.

    Todo

    Needs documentation.

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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 updateWidget

  • Update the settings for the current widget associated with the template.

    See

    Templates Update Widgets - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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 viewTemplate

  • View a single template that been created.

    See

    Templates View Template - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • template_id: string

      The id of the template.

    • 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