Interface IDashboardApi

interface IDashboardApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createDashboard(
        dashboard: Dashboard,
        teamContext: TeamContext,
    ): Promise<Dashboard>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createWidget(
        widget: Widget,
        teamContext: TeamContext,
        dashboardId: string,
    ): Promise<Widget>;
    deleteDashboard(
        teamContext: TeamContext,
        dashboardId: string,
    ): Promise<void>;
    deleteWidget(
        teamContext: TeamContext,
        dashboardId: string,
        widgetId: string,
    ): Promise<Dashboard>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getDashboard(
        teamContext: TeamContext,
        dashboardId: string,
    ): Promise<Dashboard>;
    getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>;
    getWidget(
        teamContext: TeamContext,
        dashboardId: string,
        widgetId: string,
    ): Promise<Widget>;
    getWidgetMetadata(
        contributionId: string,
        project?: string,
    ): Promise<WidgetMetadataResponse>;
    getWidgetTypes(
        scope: WidgetScope,
        project?: string,
    ): Promise<WidgetTypesResponse>;
    replaceDashboard(
        dashboard: Dashboard,
        teamContext: TeamContext,
        dashboardId: string,
    ): Promise<Dashboard>;
    replaceDashboards(
        group: DashboardGroup,
        teamContext: TeamContext,
    ): Promise<DashboardGroup>;
    replaceWidget(
        widget: Widget,
        teamContext: TeamContext,
        dashboardId: string,
        widgetId: string,
    ): Promise<Widget>;
    updateWidget(
        widget: Widget,
        teamContext: TeamContext,
        dashboardId: string,
        widgetId: string,
    ): Promise<Widget>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createDashboard createRequestOptions createWidget deleteDashboard deleteWidget formatResponse getDashboard getDashboardsByProject getWidget getWidgetMetadata getWidgetTypes replaceDashboard replaceDashboards replaceWidget updateWidget

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createDashboard

createRequestOptions

createWidget

deleteDashboard

deleteWidget

formatResponse

getDashboard

getDashboardsByProject

getWidget

getWidgetMetadata

getWidgetTypes

replaceDashboard

replaceDashboards

replaceWidget

updateWidget

Settings

Member Visibility

On This Page

Properties
Methods