次の方法で共有

DashboardRestClient class

  • リファレンス
パッケージ:
azure-devops-extension-api

VSS REST API への要求を行うために使用する (から派生する) 基本クラス

Extends
RestClientBase

コンストラクター

DashboardRestClient(IVssRestClientOptions)

プロパティ

RESOURCE_AREA_ID

メソッド

createDashboard(Dashboard, TeamContext)

指定されたダッシュボードを作成します。
createWidget(Widget, TeamContext, string)

指定したダッシュボードにウィジェットを作成します。
deleteDashboard(TeamContext, string)

ID を指定してダッシュボードを削除します。 これにより、このダッシュボードに関連付けられているウィジェットも削除されます。
deleteWidget(TeamContext, string, string)

指定したウィジェットを削除します。
getDashboard(TeamContext, string)

ID でダッシュボードを取得します。
getDashboardsByProject(TeamContext)

プロジェクトの下にあるダッシュボードの一覧を取得します。
getWidget(TeamContext, string, string)

指定したウィジェットの現在の状態を取得します。
getWidgetMetadata(string, string)

指定したコントリビューション ID を満たすウィジェット メタデータを取得します。
getWidgetTypes(WidgetScope, string)

isVisibleFromCatalog == false でマークされたウィジェットを含む、使用可能なすべてのウィジェット メタデータをアルファベット順で取得します。
replaceDashboard(Dashboard, TeamContext, string)

指定したダッシュボードの構成を置き換えます。 プロパティが指定されている場合にのみ、ダッシュボードのウィジェット リストを置き換えます。
replaceDashboards(DashboardGroup, TeamContext)

指定したグループ内のダッシュボードの名前と位置を更新し、省略されたダッシュボードを削除します。 ダッシュボードのコンテンツを変更しません。
replaceWidget(Widget, TeamContext, string, string)

指定したウィジェットの状態をオーバーライドします。
updateWidget(Widget, TeamContext, string, string)

指定したウィジェットの部分的な更新を実行します。

コンストラクターの詳細

DashboardRestClient(IVssRestClientOptions) 

new DashboardRestClient(options: IVssRestClientOptions)

パラメーター

options
IVssRestClientOptions

プロパティの詳細

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

プロパティ値

string

メソッドの詳細

createDashboard(Dashboard, TeamContext)

指定されたダッシュボードを作成します。

function createDashboard(dashboard: Dashboard, teamContext: TeamContext): Promise<Dashboard>

パラメーター

dashboard
Dashboard

ダッシュボードの初期状態

teamContext
TeamContext

操作のチーム コンテキスト

戻り値

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

指定したダッシュボードにウィジェットを作成します。

function createWidget(widget: Widget, teamContext: TeamContext, dashboardId: string): Promise<Widget>

パラメーター

widget
Widget

追加するウィジェットの状態

teamContext
TeamContext

操作のチーム コンテキスト

dashboardId

string

ウィジェットが追加されるダッシュボードの ID。

戻り値

Promise<Widget>

deleteDashboard(TeamContext, string)

ID を指定してダッシュボードを削除します。 これにより、このダッシュボードに関連付けられているウィジェットも削除されます。

function deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>

パラメーター

teamContext
TeamContext

操作のチーム コンテキスト

dashboardId

string

削除するダッシュボードの ID。

戻り値

Promise<void>

deleteWidget(TeamContext, string, string)

指定したウィジェットを削除します。

function deleteWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard>

パラメーター

teamContext
TeamContext

操作のチーム コンテキスト

dashboardId

string

ウィジェットを含むダッシュボードの ID。

widgetId

string

更新するウィジェットの ID。

戻り値

Promise<Dashboard>

getDashboard(TeamContext, string)

ID でダッシュボードを取得します。

function getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

パラメーター

teamContext
TeamContext

操作のチーム コンテキスト

dashboardId

string

戻り値

Promise<Dashboard>

getDashboardsByProject(TeamContext)

プロジェクトの下にあるダッシュボードの一覧を取得します。

function getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>

パラメーター

teamContext
TeamContext

操作のチーム コンテキスト

戻り値

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

指定したウィジェットの現在の状態を取得します。

function getWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

パラメーター

teamContext
TeamContext

操作のチーム コンテキスト

dashboardId

string

ウィジェットを含むダッシュボードの ID。

widgetId

string

読み取るウィジェットの ID。

戻り値

Promise<Widget>

getWidgetMetadata(string, string)

指定したコントリビューション ID を満たすウィジェット メタデータを取得します。

function getWidgetMetadata(contributionId: string, project?: string): Promise<WidgetMetadataResponse>

パラメーター

contributionId

string

ウィジェットのコントリビューションの ID

project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

isVisibleFromCatalog == false でマークされたウィジェットを含む、使用可能なすべてのウィジェット メタデータをアルファベット順で取得します。

function getWidgetTypes(scope: WidgetScope, project?: string): Promise<WidgetTypesResponse>

パラメーター

scope
WidgetScope
project

string

プロジェクト ID またはプロジェクト名

戻り値

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

指定したダッシュボードの構成を置き換えます。 プロパティが指定されている場合にのみ、ダッシュボードのウィジェット リストを置き換えます。

function replaceDashboard(dashboard: Dashboard, teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

パラメーター

dashboard
Dashboard

置き換えるダッシュボードの構成。

teamContext
TeamContext

操作のチーム コンテキスト

dashboardId

string

置き換えるダッシュボードの ID。

戻り値

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

指定したグループ内のダッシュボードの名前と位置を更新し、省略されたダッシュボードを削除します。 ダッシュボードのコンテンツを変更しません。

function replaceDashboards(group: DashboardGroup, teamContext: TeamContext): Promise<DashboardGroup>

パラメーター

group
DashboardGroup
teamContext
TeamContext

操作のチーム コンテキスト

戻り値

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

指定したウィジェットの状態をオーバーライドします。

function replaceWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

パラメーター

widget
Widget

ウィジェットに対して書き込まれる状態。

teamContext
TeamContext

操作のチーム コンテキスト

dashboardId

string

ウィジェットを含むダッシュボードの ID。

widgetId

string

更新するウィジェットの ID。

戻り値

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

指定したウィジェットの部分的な更新を実行します。

function updateWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

パラメーター

widget
Widget

適用するウィジェットの変更の説明。 null 以外のすべてのフィールドが置き換えられます。

teamContext
TeamContext

操作のチーム コンテキスト

dashboardId

string

ウィジェットを含むダッシュボードの ID。

widgetId

string

更新するウィジェットの ID。

戻り値

Promise<Widget>