DashboardRestClient class

الحزمة:

azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

RestClientBase

المنشئون

DashboardRestClient(IVssRestClientOptions)

الخصائص

RESOURCE_AREA_ID

الأساليب

createDashboard(Dashboard, TeamContext)	إنشاء لوحة المعلومات المتوفرة.
createWidget(Widget, TeamContext, string)	إنشاء عنصر واجهة مستخدم على لوحة المعلومات المحددة.
deleteDashboard(TeamContext, string)	حذف لوحة معلومات نظرا لمعرفها. يؤدي هذا أيضا إلى حذف عناصر واجهة المستخدم المقترنة بلوحة المعلومات هذه.
deleteWidget(TeamContext, string, string)	حذف عنصر واجهة المستخدم المحدد.
getDashboard(TeamContext, string)	احصل على لوحة معلومات حسب معرفها.
getDashboardsByProject(TeamContext)	احصل على قائمة بلوحات المعلومات ضمن مشروع.
getWidget(TeamContext, string, string)	احصل على الحالة الحالية لعنواة واجهة المستخدم المحددة.
getWidgetMetadata(string, string)	احصل على بيانات تعريف عنصر واجهة المستخدم التي تفي بمعرف المساهمة المحدد.
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

معرف لوحة المعلومات التي ستتم إضافة عنصر واجهة المستخدم إليها.

المرتجعات

Promise<Widget>

deleteDashboard(TeamContext, string)

حذف لوحة معلومات نظرا لمعرفها. يؤدي هذا أيضا إلى حذف عناصر واجهة المستخدم المقترنة بلوحة المعلومات هذه.

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

المعلمات

teamContext

TeamContext

سياق الفريق للعملية

dashboardId

string

معرف لوحة المعلومات المراد حذفه.

المرتجعات

Promise<void>

deleteWidget(TeamContext, string, string)

حذف عنصر واجهة المستخدم المحدد.

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

المعلمات

teamContext

TeamContext

سياق الفريق للعملية

dashboardId

string

معرف لوحة المعلومات التي تحتوي على عنصر واجهة المستخدم.

widgetId

string

معرف عنصر واجهة المستخدم المراد تحديثه.

المرتجعات

Promise<Dashboard>

getDashboard(TeamContext, string)

احصل على لوحة معلومات حسب معرفها.

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

معرف لوحة المعلومات التي تحتوي على عنصر واجهة المستخدم.

widgetId

string

معرف عنصر واجهة المستخدم المراد قراءته.

المرتجعات

Promise<Widget>

getWidgetMetadata(string, string)

احصل على بيانات تعريف عنصر واجهة المستخدم التي تفي بمعرف المساهمة المحدد.

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

المعلمات

contributionId

string

معرف المساهمة في عنصر واجهة المستخدم

project

string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

احصل على جميع بيانات تعريف عنصر واجهة المستخدم المتوفرة بترتيب أبجدي، بما في ذلك عناصر واجهة المستخدم المميزة ب isVisibleFromCatalog == false.

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

المعلمات

scope

WidgetScope

project

string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

استبدل التكوين للوحة المعلومات المحددة. يستبدل قائمة عناصر واجهة المستخدم على لوحة المعلومات، فقط إذا تم توفير الخاصية.

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

المعلمات

dashboard

Dashboard

تكوين لوحة المعلومات لاستبدالها.

teamContext

TeamContext

سياق الفريق للعملية

dashboardId

string

معرف لوحة المعلومات المراد استبداله.

المرتجعات

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

معرف لوحة المعلومات التي تحتوي على عنصر واجهة المستخدم.

widgetId

string

معرف عنصر واجهة المستخدم المراد تحديثه.

المرتجعات

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

قم بإجراء تحديث جزئي لعنواة واجهة المستخدم المحددة.

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

المعلمات

widget

Widget

وصف تغييرات عنصر واجهة المستخدم لتطبيقها. سيتم استبدال كافة الحقول غير الفارغة.

teamContext

TeamContext

سياق الفريق للعملية

dashboardId

string

معرف لوحة المعلومات التي تحتوي على عنصر واجهة المستخدم.

widgetId

string

معرف عنصر واجهة المستخدم المراد تحديثه.

المرتجعات

Promise<Widget>