GetDocumentMetaData Method

Overloads

GetDocumentMetaData(DocumentNode, DocumentMetaDataScope)

Declaration

      DocumentMetaData GetDocumentMetaData(DocumentNode userDocument, DocumentMetaDataScope scope)
    

Parameters

Returns

Remarks

Examples

The following code example retrieves the document metadata of a specific document and then saves it. In order to be able to find and use the correct node in the service call we call on a list of all user document nodes and then select the first one for the sake of this example.

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 qvsId = new Guid("c7c66836-f00b-47c4-8099-23ff7f178423"); // The originating QVS ID.
            IList<DocumentNode> documentNodes = apiClient.GetUserDocuments(qvsId); // Collecting a list of user document nodes.
            DocumentNode userDocument = documentNodes[0]; // Assigning the first element of the list to a new object.

            // A client call to collect the metadata for a specific document.
            DocumentMetaData documentMetaData = apiClient.GetDocumentMetaData(userDocument, DocumentMetaDataScope.All);
            Console.WriteLine("Document name:" + documentMetaData.UserDocument.Name); // Prints the name of the document.

            apiClient.SaveDocumentMetaData(documentMetaData); // Saving the document metadata that was retrieved.
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

See Also