insights.message
  • 14 Apr 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

insights.message

  • Dark
    Light
  • PDF

Article summary

Description

Toggles a message insight that persists for the lifetime of an app.


Input Parameters

NameTypeRequiredDescription
keyTextYesUnique identifier for insight
onBooleanYesVisibility toggle (true = show, false = hide)
[category]TextNoCategory to group insight within
[message]TextNoInsight message

Returns

No return value.


Examples

// show a message insight to the user
ai.insights.message("insight1", true, "Testing", "Consider echo.");
// hide (remove) a message insight
ai.insights.message("insight1", false);

Remarks

Use this function to display message-based insights to an attached intelligence experience.

Tip

Dr. Know products support insights using an Insights Panel.


What's Next