deploy: 323b555

channel-io · Oct 13, 2023 · 0a6749f · 0a6749f
1 parent e3c2c32
commit 0a6749f
Show file tree

Hide file tree

Showing 34 changed files with 346 additions and 293 deletions.
diff --git a/functions/addTags.html b/functions/addTags.html
@@ -19,27 +19,27 @@ <h1>Function addTags</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="addTags"><span class="tsd-kind-call-signature">add<wbr/>Tags</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tags</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addTags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Add a user’s tags.</p>
+<div class="tsd-comment tsd-typography"><p>Adds tags to a user.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
 <h5><span class="tsd-kind-parameter">tags</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
-<div class="tsd-comment tsd-typography"><p>If the same tag exists, only one tag is added. Max 10 tags allowed. Always lowercase.</p>
+<div class="tsd-comment tsd-typography"><p>Unique tags only. Max 10, always in lowercase.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li>
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">callback</span>: <a href="../types/Callback.html" class="tsd-signature-type tsd-kind-type-alias">Callback</a></h5>
-<div class="tsd-comment tsd-typography"><p>If it fails, the callback passes an error object at the first argument, null at the second argument. If it succeeds, the callback passes null at the first argument, a user object at the second argument.</p>
+<div class="tsd-comment tsd-typography"><p>Called on success or failure.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography">
 <h4>See</h4><p><a href="https://developers.channel.io/docs/web-channelio#addtags">https://developers.channel.io/docs/web-channelio#addtags</a></p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L556">index.ts:556</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L613">index.ts:613</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/functions/boot.html b/functions/boot.html
@@ -19,34 +19,31 @@ <h1>Function boot</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="boot"><span class="tsd-kind-call-signature">boot</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">option</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#boot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><ul>
-<li>Initialize for the SDK.</li>
-<li>Channel button shows up, and features like marketing pop-up are ready to operate.</li>
-</ul>
+<div class="tsd-comment tsd-typography"><p>Initializes the SDK, making <code>Channel button</code> and features like marketing pop-ups operational.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
 <h5><span class="tsd-kind-parameter">option</span>: <a href="../interfaces/BootOption.html" class="tsd-signature-type tsd-kind-interface">BootOption</a></h5>
-<div class="tsd-comment tsd-typography"><p>A boot option to initialize SDK.</p>
+<div class="tsd-comment tsd-typography"><p>Configuration options for initializing the SDK.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li>
 <li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">callback</span>: <a href="../types/Callback.html" class="tsd-signature-type tsd-kind-type-alias">Callback</a></h5>
-<div class="tsd-comment tsd-typography"><p>Callback called after boot. When boot fails, the callback passes an error object at the first argument, null at the second argunent. When boot succeeds, the callback passes null at the first argument, a user object at the second argument.</p>
+<div class="tsd-comment tsd-typography"><p>Function to be called after booting is complete. On failure, it receives an error object as its first argument and null as the second. On success, it receives null as the first argument and a user object as the second.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography">
 <h4>See</h4><ul>
-<li><a href="https://developers.channel.io/docs/glossary#boot">https://developers.channel.io/docs/glossary#boot</a></li>
-<li><a href="https://developers.channel.io/docs/web-boot-option">https://developers.channel.io/docs/web-boot-option</a></li>
-<li><a href="https://developers.channel.io/docs/web-user-object">https://developers.channel.io/docs/web-user-object</a></li>
+<li><a href="https://developers.channel.io/docs/glossary#boot">Boot Glossary</a></li>
+<li><a href="https://developers.channel.io/docs/web-boot-option">Boot Option</a></li>
+<li><a href="https://developers.channel.io/docs/web-user-object">User Object</a></li>
 </ul>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L248">index.ts:248</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L291">index.ts:291</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/functions/clearCallbacks.html b/functions/clearCallbacks.html
@@ -19,24 +19,14 @@ <h1>Function clearCallbacks</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="clearCallbacks"><span class="tsd-kind-call-signature">clear<wbr/>Callbacks</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clearCallbacks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><ul>
-<li>Clear all callbacks registered by following APIs.<ul>
-<li>onShowMessenger</li>
-<li>onHideMessenger</li>
-<li>onBadgeChanged</li>
-<li>onChatCreated</li>
-<li>onFollowUpChanged</li>
-<li>onUrlClicked</li>
-</ul>
-</li>
-</ul>
+<div class="tsd-comment tsd-typography"><p>Clears all registered callbacks</p>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography">
 <h4>See</h4><p><a href="https://developers.channel.io/docs/web-channelio#clearcallbacks">https://developers.channel.io/docs/web-channelio#clearcallbacks</a></p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L486">index.ts:486</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L533">index.ts:533</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/functions/hideChannelButton.html b/functions/hideChannelButton.html
@@ -19,14 +19,17 @@ <h1>Function hideChannelButton</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="hideChannelButton"><span class="tsd-kind-call-signature">hide<wbr/>Channel<wbr/>Button</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#hideChannelButton" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Hide the channel button.</p>
+<div class="tsd-comment tsd-typography"><p>Hides the channel button.</p>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography">
-<h4>See</h4><p><a href="https://developers.channel.io/docs/web-channelio#hidechannelbutton">https://developers.channel.io/docs/web-channelio#hidechannelbutton</a></p>
+<h4>See</h4><ul>
+<li><a href="https://developers.channel.io/docs/web-channelio#hidechannelbutton">ChannelIO: hidechannelbutton API</a></li>
+<li><a href="https://developers.channel.io/docs/glossary#channel-button">Channel Button Glossary</a></li>
+</ul>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L645">index.ts:645</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L705">index.ts:705</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/functions/hideMessenger.html b/functions/hideMessenger.html
@@ -19,17 +19,17 @@ <h1>Function hideMessenger</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="hideMessenger"><span class="tsd-kind-call-signature">hide<wbr/>Messenger</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#hideMessenger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Hide the messenger.</p>
+<div class="tsd-comment tsd-typography"><p>Hides the messenger interface.</p>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography">
 <h4>See</h4><ul>
-<li><a href="https://developers.channel.io/docs/web-channelio#hidemessenger">https://developers.channel.io/docs/web-channelio#hidemessenger</a></li>
-<li><a href="https://developers.channel.io/docs/glossary#messenger">https://developers.channel.io/docs/glossary#messenger</a></li>
+<li><a href="https://developers.channel.io/docs/web-channelio#hidemessenger">ChannelIO: hidemessenger API</a></li>
+<li><a href="https://developers.channel.io/docs/glossary#messenger">Messenger Glossary</a></li>
 </ul>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L297">index.ts:297</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L342">index.ts:342</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/functions/loadScript.html b/functions/loadScript.html
@@ -19,16 +19,16 @@ <h1>Function loadScript</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="loadScript"><span class="tsd-kind-call-signature">load<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#loadScript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><ul>
-<li>Load the Channel SDK script.</li>
-<li>This method is only executable on browser.</li>
-<li>If Channel SDK script is already loaded, this method does nothing.</li>
+<div class="tsd-comment tsd-typography"><p>Loads the Channel SDK script into the document.</p>
+<ul>
+<li>Browser-only: This function can only be executed in a browser environment.</li>
+<li>Idempotent: If the Channel SDK script is already loaded, calling this function has no effect.</li>
 </ul>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L113">index.ts:113</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L126">index.ts:126</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/functions/onBadgeChanged.html b/functions/onBadgeChanged.html
@@ -30,13 +30,12 @@ <h5><span class="tsd-kind-parameter">callback</span>: <a href="../types/BadgeCha
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography">
 <h4>See</h4><ul>
-<li><a href="https://developers.channel.io/docs/web-channelio#onbadgechanged">https://developers.channel.io/docs/web-channelio#onbadgechanged</a></li>
-<li><a href="https://developers.channel.io/docs/glossary#channel-button">https://developers.channel.io/docs/glossary#channel-button</a></li>
-<li><a href="https://developers.channel.io/docs/web-customization">https://developers.channel.io/docs/web-customization</a></li>
+<li><a href="https://developers.channel.io/docs/web-channelio#onbadgechanged">ChannelIO: onbadgechanged API</a></li>
+<li><a href="https://developers.channel.io/docs/web-customization">Customization</a></li>
 </ul>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L400">index.ts:400</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L450">index.ts:450</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/functions/onChatCreated.html b/functions/onChatCreated.html
@@ -19,13 +19,15 @@ <h1>Function onChatCreated</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="onChatCreated"><span class="tsd-kind-call-signature">on<wbr/>Chat<wbr/>Created</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#onChatCreated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Register a callback invoked when a chat is created.</p>
+<div class="tsd-comment tsd-typography"><p>Registers a callback function that is invoked when a chat is created.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
 <h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
+<div class="tsd-comment tsd-typography"><p>The callback function to be executed.</p>
+</div>
 <div class="tsd-comment tsd-typography"></div>
 <ul class="tsd-parameters">
 <li class="tsd-parameter-signature">
@@ -36,7 +38,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L416">index.ts:416</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L466">index.ts:466</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/functions/onFollowUpChanged.html b/functions/onFollowUpChanged.html
@@ -19,22 +19,22 @@ <h1>Function onFollowUpChanged</h1></div>
 <ul class="tsd-signatures">
 <li class="tsd-signature tsd-anchor-link" id="onFollowUpChanged"><span class="tsd-kind-call-signature">on<wbr/>Follow<wbr/>Up<wbr/>Changed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#onFollowUpChanged" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Register a callback invoked when the user changes the user’s profile.</p>
+<div class="tsd-comment tsd-typography"><p>Registers a callback function that is invoked when the user updates their profile.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
 <h5><span class="tsd-kind-parameter">callback</span>: <a href="../types/FollowUpChangedCallback.html" class="tsd-signature-type tsd-kind-type-alias">FollowUpChangedCallback</a></h5>
-<div class="tsd-comment tsd-typography"><p>The callback invoked when the user changes the user’s profile. It receives the profile object as the argument.</p>
+<div class="tsd-comment tsd-typography"><p>The callback function, receiving the <code>FollowUpProfile</code> object as an argument.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography">
 <h4>See</h4><p><a href="https://developers.channel.io/docs/web-channelio#onfollowupchanged">https://developers.channel.io/docs/web-channelio#onfollowupchanged</a></p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/07f59c4/src/index.ts#L442">index.ts:442</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/channel-io/channel-web-sdk-loader/blob/323b555/src/index.ts#L495">index.ts:495</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">