Loading TOC...

alert.ruleSetDescription

alert.ruleSetDescription(
   $rule as Object,
   $description as String
) as Object

Summary

This function returns the rule with the description of the rule updated.

Parameters
$rule The representation of a rule.
$descriptionThe description value to set for the given rule.

Example

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

  alert.ruleSetDescription(
    alert.getAllRules("http://acme.com/alert/message-board", cts.wordQuery("dna"))[0],
    "Email when new article about DNA")

  => Returns the JSON representation of the rule with the description 
     updated to "Email when new article about DNA"
  

Comments

    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy