<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>ui.tourtips Client Message</title><link>https://community.telligent.com/community/11/w/api-documentation/67130/ui-tourtips-client-message</link><description /><dc:language>en-US</dc:language><generator>14.0.0.586 14</generator><item><title>ui.tourtips Client Message</title><link>https://community.telligent.com/community/11/w/api-documentation/67130/ui-tourtips-client-message</link><pubDate>Tue, 19 Nov 2019 20:27:07 GMT</pubDate><guid isPermaLink="false">43faad70-25d9-4dba-a923-e0631cf9a09c</guid><dc:creator>Ben Tiedt</dc:creator><comments>https://community.telligent.com/community/11/w/api-documentation/67130/ui-tourtips-client-message#comments</comments><description>Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:27:07&lt;br /&gt;
&lt;hr class="generated-documentation-start" style="border-width:0;" /&gt;&lt;h3&gt;&lt;a id="ui_tourtips_Client_Message" name="ui_tourtips_Client_Message"&gt;&lt;/a&gt;ui.tourtips Client Message&lt;/h3&gt;
&lt;p&gt;[[messaging JavaScript API Module|Client-side message]] raised when a set of tour tips registered by widgets have been determined to be in an unread state, and are available to be presented to the user.&lt;/p&gt;
&lt;p&gt;Please refer to the [[tourTips JavaScript API Module|tourTips]] module for more information.&lt;/p&gt;
&lt;h3&gt;&lt;a id="Usage" name="Usage"&gt;&lt;/a&gt;Usage&lt;/h3&gt;
&lt;pre&gt;&lt;code&gt;$.telligent.evolution.messaging.subscribe(&amp;#39;ui.tourtips&amp;#39;, function(data) {
    // handle the event
});
&lt;/code&gt;&lt;/pre&gt;

&lt;h3&gt;&lt;a id="Data" name="Data"&gt;&lt;/a&gt;Data&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;
&lt;code&gt;tips&lt;/code&gt;: array of objects, each containing
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;key&lt;/code&gt;: (string) Unique tip identifier&lt;/li&gt;
&lt;li&gt;&lt;code&gt;message&lt;/code&gt;: (string) Tip content&lt;/li&gt;
&lt;li&gt;&lt;code&gt;index&lt;/code&gt;: (number) Index at which to show the tip&lt;/li&gt;
&lt;li&gt;&lt;code&gt;element&lt;/code&gt;: (DOM element) HTML element associated with the tip&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;h3&gt;&lt;a id="Related" name="Related"&gt;&lt;/a&gt;Related&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;[[tourTips JavaScript API Module|tourTips]] module&lt;/li&gt;
&lt;li&gt;[[tourtip UI Component|ui-tourtip]] [[ui JavaScript API Module|UI Component]]&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$core_v2_tourTip.Render&lt;/code&gt; Widget API&lt;/li&gt;
&lt;/ul&gt;
&lt;hr class="generated-documentation-end" style="border-width:0;" /&gt;&lt;div style="clear:both;"&gt;&lt;/div&gt;
</description></item></channel></rss>