GetServerObjects Method

Overloads

GetServerObjects(Guid, String)

Declaration

      List<ServerObject> GetServerObjects(Guid qvsID, string documentName)
    

Parameters

Returns

Remarks

Examples

This example retrieves the server objects from a document hosted by a Qlik View Server and writes the information 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();

           //Find a QlikView Server       
           ServiceInfo qvsService = apiClient.GetServices(ServiceTypes.QlikViewServer).FirstOrDefault();

           if (qvsService != null)
           {
               //Get all the collaboration objects
               List<ServerObject> serverObjects = apiClient.GetServerObjects(qvsService.ID, "SomeQVDoc.qvw");
               serverObjects.ForEach(t =>
                   {
                       Console.WriteLine("==========================");
                       Console.WriteLine("ID:{0}", t.Id);
                       Console.WriteLine("Type:{0}", t.Type);
                       Console.WriteLine("SubType:{0}", t.SubType);
                       Console.WriteLine("Owner:{0}", t.OwnerName);
                       Console.WriteLine("Last modified:{0}", t.UtcModifyTime);
                       Console.WriteLine("Shared:{0}", t.Shared);
                       Console.WriteLine("==========================");
                       Console.WriteLine();
                   });
           }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}