Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetsApi

Hierarchy

  • WidgetsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

createWidget

  • createWidget(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Widget>

  • Create a widget on the specified dashboard.

    Parameters

    • params: object
      • apiVersion: string
      • body: Widget
      • dashboardId: string
      • organization: string
      • project: string
      • team: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Widget>

deleteWidget

  • deleteWidget(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Dashboard>

  • Delete the specified widget.

    Parameters

    • params: object
      • apiVersion: string
      • dashboardId: string
      • organization: string
      • project: string
      • team: string
      • widgetId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Dashboard>

getWidget

  • getWidget(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Widget>

  • Get the current state of the specified widget.

    Parameters

    • params: object
      • apiVersion: string
      • dashboardId: string
      • organization: string
      • project: string
      • team: string
      • widgetId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Widget>

getWidgets

  • getWidgets(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Widget>>

  • Get widgets contained on the specified dashboard.

    Parameters

    • params: object
      • apiVersion: string
      • dashboardId: string
      • Optional eTag?: string
      • organization: string
      • project: string
      • team: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Widget>>

replaceWidget

  • replaceWidget(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Widget>

  • Override the state of the specified widget.

    Parameters

    • params: object
      • apiVersion: string
      • body: Widget
      • dashboardId: string
      • organization: string
      • project: string
      • team: string
      • widgetId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Widget>

replaceWidgets

  • replaceWidgets(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Widget>>

  • Replace the widgets on specified dashboard with the supplied widgets.

    Parameters

    • params: object
      • apiVersion: string
      • body: Array<Widget>
      • dashboardId: string
      • Optional eTag?: string
      • organization: string
      • project: string
      • team: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Widget>>

updateWidget

  • updateWidget(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Widget>

  • Perform a partial update of the specified widget.

    Parameters

    • params: object
      • apiVersion: string
      • body: Widget
      • dashboardId: string
      • organization: string
      • project: string
      • team: string
      • widgetId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Widget>

updateWidgets

  • updateWidgets(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Widget>>

  • Update the supplied widgets on the dashboard using supplied state. State of existing Widgets not passed in the widget list is preserved.

    Parameters

    • params: object
      • apiVersion: string
      • body: Array<Widget>
      • dashboardId: string
      • Optional eTag?: string
      • organization: string
      • project: string
      • team: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Widget>>

Generated using TypeDoc