Question

的VSTS仪表板小部件

但是我在使用getWorkItem（）函数时遇到了问题。我希望在给定的 Epic 下获得所有功能的 ID （我已经知道了史诗ID）。我相信如果我将getWorkItem（）的扩展参数设置为＆＃34; All＆＃34;我将获得所有功能及其各自ID的列表。不幸的是我不知道如何定义＆＃34;类型＆＃34;扩展参数以及如何将其作为值正确传递给getWorkItem（）函数。

这是我的代码：

VSS.require(["VSS/Service", "TFS/Dashboards/WidgetHelpers", "TFS/WorkItemTracking/RestClient"],
        function (VSS_Service, WidgetHelpers, TFS_Wit_WebApi) {
            WidgetHelpers.IncludeWidgetStyles();
            VSS.register("myapp", function () {
                var fetchData = function (widgetSettings) {
                    const epicID = 123456;
                    // Get a WIT client to make REST calls to VSTS
                    return VSS_Service.getCollectionClient(TFS_Wit_WebApi.WorkItemTrackingHttpClient).getWorkItem(123456, null, null, All).
                        then(
                            //Successful retrieval of workItems
                            function (workItems) {
                                $('#myText').text(JSON.stringify(workItems));
                                console.log(workItems);
                                // Use the widget helper and return success as Widget Status
                                return WidgetHelpers.WidgetStatusHelper.Success();
                            },
                            function (error) {
                                // Use the widget helper and return failure as Widget Status
                                return WidgetHelpers.WidgetStatusHelper.Failure(error.message);
                            });
                }

以下是expand的VSTS参考它解释了值是什么，但没有说明如何将它传递给getWorkItem（）函数。

我想将函数的可选扩展参数设置为＆＃34; All＆＃34;但不知道它的类型以及如何正确定义和使用它。

Answer 1

使用枚举是好的，但是您也可以从“ TFS / WorkItemTracking / Contracts”模块中传递值。您可以在此处找到参考（显示模块路径，“类”和枚举）：

https://docs.microsoft.com/en-us/vsts/extend/reference/client/api/tfs/workitemtracking/contracts/workitemexpand?view=vsts

上面的链接来自TFS WorkItemTracking API参考，可以在这里找到：

https://docs.microsoft.com/en-us/vsts/extend/reference/client/api/tfs/workitemtracking/restclient/workitemtrackinghttpclient2_2?view=vsts#getworkitem()

在这里，您可以在代码中添加它：

声明“ TFS / WorkItemTracking /合同”模块
将模块传递到回调中（在下面的示例中为“ _Contracts”）
根据需要使用“ _Contracts”

这是您的代码，已更新为使用“合同”模块：

VSS.require([
    "VSS/Service", 
    "TFS/Dashboards/WidgetHelpers", 
    "TFS/WorkItemTracking/RestClient",
    "TFS/WorkItemTracking/Contracts"],
    function (VSS_Service, WidgetHelpers, TFS_Wit_WebApi, _Contracts) {

    WidgetHelpers.IncludeWidgetStyles();
    VSS.register("myapp", function () {
        var fetchData = function (widgetSettings) {
            const epicID = 123456;
            // Get a WIT client to make REST calls to VSTS
            return VSS_Service.getCollectionClient(TFS_Wit_WebApi.WorkItemTrackingHttpClient).
                getWorkItem(123456, null, null, _Contracts.WorkItemExpand.All).
                then(
                    //Successful retrieval of workItems
                    function (workItems) {
                        $('#myText').text(JSON.stringify(workItems));
                        console.log(workItems);
                        // Use the widget helper and return success as Widget Status
                        return WidgetHelpers.WidgetStatusHelper.Success();
                    },
                    function (error) {
                        // Use the widget helper and return failure as Widget Status
                        return WidgetHelpers.WidgetStatusHelper.Failure(error.message);
                    });
        }
    });
});

希望有帮助！

VSTS仪表板小组件getWorkItem可选参数展开

1 个答案: