Skip to content

Commit 437827e

Browse files
esezenesezen
committed
Add metadata field to results_config response
1 parent 6bbdb82 commit 437827e

23 files changed

+27
-27
lines changed

dist/constructorio-client-javascript-2.67.4.js renamed to dist/constructorio-client-javascript-2.67.5.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/ConstructorIO.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1671,7 +1671,7 @@ <h6>Properties</h6>
16711671
<br class="clear">
16721672

16731673
<footer>
1674-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1674+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
16751675
</footer>
16761676

16771677
<script>prettyPrint();</script>

‎docs/constructorio.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ <h1 class="page-title">constructorio.js</h1>
260260
<br class="clear">
261261

262262
<footer>
263-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
263+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
264264
</footer>
265265

266266
<script>prettyPrint();</script>

‎docs/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ <h2>3. Implement the Client</h2>
8787
});
8888
</code></pre>
8989
<h2>4. Retrieve Results</h2>
90-
<p>After instantiating an instance of the client, four modules will be exposed as properties to help retrieve data from Constructor.io: <code>search</code>, <code>browse</code>, <code>autocomplete</code>, <code>recommendations</code> and <code>tracker</code>.</p>
90+
<p>After instantiating an instance of the client, seven modules will be exposed as properties to help retrieve data or send behavioral events: <code>search</code>, <code>browse</code>, <code>autocomplete</code>, <code>recommendations</code>, <code>quizzes</code>, <code>agent</code>, and <code>tracker</code>.</p>
9191
<h4>Dispatched events</h4>
92-
<p>The <code>search</code>, <code>browse</code>, <code>recommendations</code> and <code>autocomplete</code> modules may dispatch custom events on <code>window</code> with response data when a request has been completed. The event name follows the following structure: <code>cio.client.[moduleName].[methodName].completed</code>. Example consuming code can be found below:</p>
92+
<p>Modules may dispatch custom events on the browser <code>window</code> with response data when a request has been completed. The event name follows the following structure: <code>cio.client.[moduleName].[methodName].completed</code>. Example consuming code can be found below:</p>
9393
<pre class="prettyprint source lang-javascript"><code>window.addEventListener('cio.client.search.getSearchResults.completed', (event) => {
9494
// `event.detail` will be response data
9595
}, false);
@@ -114,7 +114,7 @@ <h2>Development / npm commands</h2>
114114
<br class="clear">
115115

116116
<footer>
117-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
117+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
118118
</footer>
119119

120120
<script>prettyPrint();</script>

‎docs/module-agent.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ <h5 class="h5-returns">Returns:</h5>
459459
<br class="clear">
460460

461461
<footer>
462-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
462+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
463463
</footer>
464464

465465
<script>prettyPrint();</script>

‎docs/module-assistant.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@ <h5 class="h5-returns">Returns:</h5>
457457
<br class="clear">
458458

459459
<footer>
460-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
460+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
461461
</footer>
462462

463463
<script>prettyPrint();</script>

‎docs/module-autocomplete.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ <h5 class="h5-returns">Returns:</h5>
798798
<br class="clear">
799799

800800
<footer>
801-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
801+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
802802
</footer>
803803

804804
<script>prettyPrint();</script>

‎docs/module-browse.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3136,7 +3136,7 @@ <h5 class="h5-returns">Returns:</h5>
31363136
<br class="clear">
31373137

31383138
<footer>
3139-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
3139+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
31403140
</footer>
31413141

31423142
<script>prettyPrint();</script>

‎docs/module-quizzes.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1661,7 +1661,7 @@ <h5 class="h5-returns">Returns:</h5>
16611661
<br class="clear">
16621662

16631663
<footer>
1664-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1664+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
16651665
</footer>
16661666

16671667
<script>prettyPrint();</script>

‎docs/module-recommendations.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ <h5 class="h5-returns">Returns:</h5>
798798
<br class="clear">
799799

800800
<footer>
801-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 26 2025 18:56:19 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
801+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Sep 08 2025 07:34:19 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
802802
</footer>
803803

804804
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)