GetAlertText Method
Overloads
GetAlertText() |
Returns a simple text message describing the current state of the QMS. |
GetAlertText()
Returns a simple text message describing the current state of the QMS.
Declaration
string GetAlertText()
Returns
Type | Description |
---|---|
System.String |
A text message |
Remarks
security
Requires membership of local group QlikView Management API.
Examples
The following code example retrieves the alert string from the QMS and prints it if it is not empty.
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();
string alert = apiClient.GetAlertText();
if(!string.IsNullOrWhiteSpace(alert))
Console.WriteLine("Alert message from QMS:" + alert);
}
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!