GetTaskStatuses Method

Overloads

GetTaskStatuses(TaskStatusFilter, TaskStatusScope)

Declaration

      List<TaskStatus> GetTaskStatuses(TaskStatusFilter filter, TaskStatusScope scope)
    

Parameters

Returns

Remarks

Examples

The following code example retrieves a list of all task statuses which are running, and then writes part of the extended metadata of the first element in the list to the console.

The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.

    using System;
using System.Collections.Generic;
using System.Linq;
using QMSAPI;

class Program
{
    static void Main(string[] args)
    {
        try
        {
            // create a QMS API client
            IQMS apiClient = new QMSClient();

            //retrieve a time limited service key
            ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();        

            TaskStatusFilter taskStatusFilter = new TaskStatusFilter();
            taskStatusFilter.TaskStatuses.Add(TaskStatusValue.Running);
            List<TaskStatus> taskStatuses = apiClient.GetTaskStatuses(taskStatusFilter, TaskStatusScope.Extended); // A service call.
            Console.WriteLine(taskStatuses[0].Extended.TaskSummary.ToString()); // Print part of the metadata of the first element in the list.
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

See Also