alert.ruleGetDescription

alert.ruleGetDescription(
   rule as Object
) as String

Summary

This function returns the description of a given rule.

Parameters
rule	The representation of a rule.

Example

  const alert = require("/MarkLogic/alert.xqy");

  alert.ruleGetDescription(
       alert.getAllRules("http://acme.com/alert/message-board", cts.wordQuery("dna"))[0] )
  => "Alert me to anything concerning nucleic acids"