RemoteGetTasks Method
Overloads
RemoteGetTasks(Guid, Guid) |
Retrieves all tasks from a remote QlikViewDistribution Service. |
RemoteGetTasks(Guid, Guid)
Retrieves all tasks from a remote QlikViewDistribution Service.
Declaration
List<TaskInfo> RemoteGetTasks(Guid remoteQmsId, Guid remoteQdsId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | remoteQmsId |
The ID of the remote QlikView Management Service. |
System.Guid | remoteQdsId |
The ID of the remote QlikView Distribution Service |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<TaskInfo> |
A list of all tasks found. |
Remarks
security
Requires membership of local group QlikView Management API and the role Document Folder Administrator.
Examples
This example retrieves a remote QlikView Management Service and prints information about all tasks on the QDS's found on it.
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();
//Get a remote QlikView Management service.
ServiceInfo remoteQMSService = apiClient.GetServices(ServiceTypes.RemoteQlikViewManagementService).FirstOrDefault();
if (remoteQMSService != null)
{
//Get all QlikView Distribution services on the remote QMS.
List<ServiceInfo> remoteQDS = apiClient.RemoteGetServices(remoteQMSService.ID, ServiceTypes.QlikViewDistributionService);
{
//Print the name of the QDS and the tasks found.
remoteQDS.ForEach(delegate(ServiceInfo qdsInfo)
{
Console.WriteLine("Tasks on " + qdsInfo.Name);
List<TaskInfo> remoteTasks = apiClient.RemoteGetTasks(remoteQMSService.ID, qdsInfo.ID);
remoteTasks.ForEach( delegate (TaskInfo task)
{
Console.WriteLine(string.Format("Name:{0}\nID:{1}Enabled:{2}\nType:{3}\n", task.Name, task.ID, task.Enabled, task.Type));
});
}
);
}
}
}
catch (Exception ex)
{
Console.WriteLine("An exception occurred: " + ex.Message);
}
// wait for user to press any key
Console.ReadLine();
}
}
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!