DeleteTask Method

Overloads

DeleteTask(Guid, TaskType)

Declaration

      bool DeleteTask(Guid taskID, TaskType taskType)
    

Parameters

Returns

Remarks

Examples

The following code example simply deletes a task. Note however that there is no generic task type so you must to define the type parameter correctly.

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();

            Guid taskId = new Guid("ad549720-6bb5-4c66-b8c7-c6a5fb68e2a9"); // A known task Guid.

            bool result = apiClient.DeleteTask(taskId, TaskType.PauseTask); // A service call. Only applicable to pause type tasks.
            Console.WriteLine(result ? "Task deleted succesfully." : "Failed to delete task");
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

See Also