sidechat.js 2.5.6 → 2.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/dist/classes/SidechatAPIClient.d.ts +32 -3
  2. package/dist/classes/SidechatAPIClient.d.ts.map +1 -1
  3. package/dist/index.cjs +121 -8
  4. package/dist/index.mjs +121 -8
  5. package/dist/types/SidechatTypes.d.ts +69 -3
  6. package/dist/types/SidechatTypes.d.ts.map +1 -1
  7. package/docs/sidechat.js/2.6.0/SidechatAPIClient.html +3 -0
  8. package/docs/sidechat.js/2.6.0/SidechatAPIError.html +3 -0
  9. package/docs/sidechat.js/2.6.0/SidechatColorList.html +3 -0
  10. package/docs/sidechat.js/{2.4.9 → 2.6.0}/classes_SidechatAPIClient.js.html +237 -9
  11. package/docs/sidechat.js/2.6.0/classes_SidechatAPIError.js.html +16 -0
  12. package/docs/sidechat.js/2.6.0/classes_SidechatColorList.js.html +79 -0
  13. package/docs/sidechat.js/2.6.0/data/search.json +1 -0
  14. package/docs/sidechat.js/2.6.0/global.html +3 -0
  15. package/docs/sidechat.js/2.6.0/index.html +4 -0
  16. package/docs/sidechat.js/2.6.0/tutorial-Authentication.html +14 -0
  17. package/docs/sidechat.js/2.6.0/tutorial-Email Registration.html +6 -0
  18. package/docs/sidechat.js/{2.4.9 → 2.6.0}/types_SidechatTypes.js.html +51 -7
  19. package/docs/sidechat.js/2.6.1/SidechatAPIClient.html +3 -0
  20. package/docs/sidechat.js/2.6.1/SidechatAPIError.html +3 -0
  21. package/docs/sidechat.js/2.6.1/SidechatColorList.html +3 -0
  22. package/docs/sidechat.js/2.6.1/classes_SidechatAPIClient.js.html +1358 -0
  23. package/docs/sidechat.js/2.6.1/classes_SidechatAPIError.js.html +16 -0
  24. package/docs/sidechat.js/2.6.1/classes_SidechatColorList.js.html +79 -0
  25. package/docs/sidechat.js/2.6.1/data/search.json +1 -0
  26. package/docs/sidechat.js/2.6.1/fonts/Inconsolata-Regular.ttf +0 -0
  27. package/docs/sidechat.js/2.6.1/fonts/OpenSans-Regular.ttf +0 -0
  28. package/docs/sidechat.js/2.6.1/fonts/WorkSans-Bold.ttf +0 -0
  29. package/docs/sidechat.js/2.6.1/global.html +3 -0
  30. package/docs/sidechat.js/2.6.1/index.html +4 -0
  31. package/docs/sidechat.js/2.6.1/scripts/core.js +726 -0
  32. package/docs/sidechat.js/2.6.1/scripts/core.min.js +23 -0
  33. package/docs/sidechat.js/2.6.1/scripts/resize.js +90 -0
  34. package/docs/sidechat.js/2.6.1/scripts/search.js +265 -0
  35. package/docs/sidechat.js/2.6.1/scripts/search.min.js +6 -0
  36. package/docs/sidechat.js/2.6.1/scripts/third-party/Apache-License-2.0.txt +202 -0
  37. package/docs/sidechat.js/2.6.1/scripts/third-party/fuse.js +9 -0
  38. package/docs/sidechat.js/2.6.1/scripts/third-party/hljs-line-num-original.js +369 -0
  39. package/docs/sidechat.js/2.6.1/scripts/third-party/hljs-line-num.js +1 -0
  40. package/docs/sidechat.js/2.6.1/scripts/third-party/hljs-original.js +5171 -0
  41. package/docs/sidechat.js/2.6.1/scripts/third-party/hljs.js +1 -0
  42. package/docs/sidechat.js/2.6.1/scripts/third-party/popper.js +5 -0
  43. package/docs/sidechat.js/2.6.1/scripts/third-party/tippy.js +1 -0
  44. package/docs/sidechat.js/2.6.1/scripts/third-party/tocbot.js +672 -0
  45. package/docs/sidechat.js/2.6.1/scripts/third-party/tocbot.min.js +1 -0
  46. package/docs/sidechat.js/2.6.1/styles/clean-jsdoc-theme-base.css +1159 -0
  47. package/docs/sidechat.js/2.6.1/styles/clean-jsdoc-theme-dark.css +412 -0
  48. package/docs/sidechat.js/2.6.1/styles/clean-jsdoc-theme-light.css +482 -0
  49. package/docs/sidechat.js/2.6.1/styles/clean-jsdoc-theme-scrollbar.css +30 -0
  50. package/docs/sidechat.js/2.6.1/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
  51. package/docs/sidechat.js/2.6.1/styles/clean-jsdoc-theme.min.css +1 -0
  52. package/docs/sidechat.js/2.6.1/tutorial-Authentication.html +14 -0
  53. package/docs/sidechat.js/2.6.1/tutorial-Email Registration.html +6 -0
  54. package/docs/sidechat.js/2.6.1/types_SidechatTypes.js.html +204 -0
  55. package/package.json +1 -1
  56. package/src/classes/SidechatAPIClient.js +90 -2
  57. package/src/types/SidechatTypes.js +31 -6
  58. package/docs/sidechat.js/2.4.9/SidechatAPIClient.html +0 -3
  59. package/docs/sidechat.js/2.4.9/SidechatAPIError.html +0 -3
  60. package/docs/sidechat.js/2.4.9/SidechatColorList.html +0 -3
  61. package/docs/sidechat.js/2.4.9/classes_SidechatAPIError.js.html +0 -16
  62. package/docs/sidechat.js/2.4.9/classes_SidechatColorList.js.html +0 -79
  63. package/docs/sidechat.js/2.4.9/data/search.json +0 -1
  64. package/docs/sidechat.js/2.4.9/global.html +0 -3
  65. package/docs/sidechat.js/2.4.9/index.html +0 -4
  66. package/docs/sidechat.js/2.4.9/tutorial-Authentication.html +0 -14
  67. package/docs/sidechat.js/2.4.9/tutorial-Email Registration.html +0 -6
  68. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/fonts/Inconsolata-Regular.ttf +0 -0
  69. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/fonts/OpenSans-Regular.ttf +0 -0
  70. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/fonts/WorkSans-Bold.ttf +0 -0
  71. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/core.js +0 -0
  72. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/core.min.js +0 -0
  73. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/resize.js +0 -0
  74. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/search.js +0 -0
  75. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/search.min.js +0 -0
  76. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/Apache-License-2.0.txt +0 -0
  77. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/fuse.js +0 -0
  78. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/hljs-line-num-original.js +0 -0
  79. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/hljs-line-num.js +0 -0
  80. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/hljs-original.js +0 -0
  81. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/hljs.js +0 -0
  82. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/popper.js +0 -0
  83. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/tippy.js +0 -0
  84. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/tocbot.js +0 -0
  85. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/scripts/third-party/tocbot.min.js +0 -0
  86. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/styles/clean-jsdoc-theme-base.css +0 -0
  87. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/styles/clean-jsdoc-theme-dark.css +0 -0
  88. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/styles/clean-jsdoc-theme-light.css +0 -0
  89. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/styles/clean-jsdoc-theme-scrollbar.css +0 -0
  90. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/styles/clean-jsdoc-theme-without-scrollbar.min.css +0 -0
  91. /package/docs/sidechat.js/{2.4.9 → 2.6.0}/styles/clean-jsdoc-theme.min.css +0 -0
package/docs/sidechat.js/2.6.1/tutorial-Email Registration.html ADDED
@@ -0,0 +1,6 @@
1
+ <!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Tutorial: Email Registration</title><!--[if lt IE 9]>
2
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
+ <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">sidechat.js</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div><div class="sidebar-section-children"><a href="SidechatColorList.html">SidechatColorList</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatColor">SidechatColor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCurrentUser">SidechatCurrentUser</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectMessage">SidechatDirectMessage</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectThread">SidechatDirectThread</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIcon">SidechatIcon</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatMembership">SidechatMembership</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPoll">SidechatPoll</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPollChoice">SidechatPollChoice</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatProfile">SidechatProfile</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/sidechat.js" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/sidechat.js" target="_blank">NPM</a></div><div class="navbar-item"><a id="" href="https://offsides.micahlindley.com" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h2>Email Registration</h2></header><article><blockquote><p>You can only start this process once you have <a href="tutorial-Authentication.html">authenticated as a user</a>.</p></blockquote><p>Start by sending a verification email to the user:</p><pre class="prettyprint source lang-javascript"><code>const email = /* User's email address */;
4
+ await API.registerEmail(email);
5
+ </code></pre><p>Once the user has clicked the link in the verification email, verify that they've clicked it:</p><pre class="prettyprint source lang-javascript"><code>await API.checkEmailVerification();
6
+ </code></pre><p>You should be verified!</p></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">sidechat.js</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/sidechat.js" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/sidechat.js" target="_blank">NPM</a></div><div class="navbar-item"><a id="" href="https://offsides.micahlindley.com" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div><div class="sidebar-section-children"><a href="SidechatColorList.html">SidechatColorList</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatColor">SidechatColor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCurrentUser">SidechatCurrentUser</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectMessage">SidechatDirectMessage</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectThread">SidechatDirectThread</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIcon">SidechatIcon</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatMembership">SidechatMembership</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPoll">SidechatPoll</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPollChoice">SidechatPollChoice</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatProfile">SidechatProfile</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
package/docs/sidechat.js/2.6.1/types_SidechatTypes.js.html ADDED
@@ -0,0 +1,204 @@
1
+ <!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: types/SidechatTypes.js</title><!--[if lt IE 9]>
2
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
+ <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">sidechat.js</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div><div class="sidebar-section-children"><a href="SidechatColorList.html">SidechatColorList</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatColor">SidechatColor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCurrentUser">SidechatCurrentUser</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectMessage">SidechatDirectMessage</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectThread">SidechatDirectThread</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIcon">SidechatIcon</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatMembership">SidechatMembership</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPoll">SidechatPoll</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPollChoice">SidechatPollChoice</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatProfile">SidechatProfile</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/sidechat.js" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/sidechat.js" target="_blank">NPM</a></div><div class="navbar-item"><a id="" href="https://offsides.micahlindley.com" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">types_SidechatTypes.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
4
+ * A user-created post or comment, depending on the "type" prop
5
+ * @typedef {Object} SidechatPostOrComment
6
+ * @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
7
+ * @prop {String} id - alphanumeric ID of post or comment
8
+ * @prop {Boolean} authored_by_user - whether or not the post or comment was created by the current user
9
+ * @prop {String} alias - post creator's name in-app
10
+ * @prop {String} group_id - alphanumeric ID of group
11
+ * @prop {SidechatGroup} group - group in which post or comment was created
12
+ * @prop {String} text - text content of post or comment
13
+ * @prop {String} created_at - date string of post or comment creation time
14
+ * @prop {Number} vote_total - sum of upvotes and downvotes
15
+ * @prop {SidechatVoteString} vote_status - current user's vote on post or comment
16
+ * @prop {SidechatSimpleAsset[]} assets - array of simple assets attached to post or comment
17
+ * @prop {Array} attachments - undocumented
18
+ * @prop {Boolean} dms_disabled - whether or not you can send a DM to creator of post
19
+ * @prop {String[]} tags - undocumented
20
+ * @prop {SidechatIdentity} identity - creator's identity information
21
+ * @prop {Boolean} pinned - undocumented
22
+ * @prop {Boolean} is_saved - whether or not the current user has saved the post
23
+ * @prop {"following"|"not_following"} follow_status - whether or not the current user should recieve activity notifications for the post
24
+ * @prop {"group"} [destination] - undocumented
25
+ * @prop {Number} [comment_count] - number of comments on post (only if type=post)
26
+ * @prop {Boolean} [comments_disabled] - whether or not you can comment on post (only if type=post)
27
+ * @prop {SidechatPoll} [poll] - poll attached to post (only if the post has a poll)
28
+ * @prop {String} [parent_post_id] - alphanumeric ID of parent post (only if type=comment)
29
+ * @prop {String} [reply_post_id] - alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
30
+ * @prop {String} [context] - text content of comment being replied to, falls back to text (only if type=comment)
31
+ */
32
+
33
+ /**
34
+ * A group object, containing metadata about a group as well as its join conditions and states. Some properties vary based on the endpoint the object came from.
35
+ * @typedef {Object} SidechatGroup
36
+ * @prop {String} id - alphanumeric ID of group
37
+ * @prop {String} name - human-readable name of group
38
+ * @prop {String} analytics_name - name to file group under
39
+ * @prop {"non_member"|"member"} membership_type - whether or not current user is a member of group
40
+ * @prop {String} color - group's theme color as hex code (e.g., #FFFFFF)
41
+ * @prop {"open"|"closed"|"email_domain"} group_join_type - basis on which group accepts new members
42
+ * @prop {"private"|"public_to_all"|"public_to_schools"} group_visibility - group's visibility setting
43
+ * @prop {"show"|"hide"} asset_library_visibility - whether or not group's asset library is visible
44
+ * @prop {Array} [roles] - undocumented
45
+ * @prop {String} [description] - description of group
46
+ * @prop {SidechatPrivateAssetURL} [icon_url] - image URL for group icon
47
+ * @prop {Number} [member_count] - number of users in group
48
+ * @prop {Boolean} [should_show_leaderboard] - undocumented
49
+ */
50
+
51
+ /**
52
+ * An asset object, containing information about an image within a post or comment
53
+ * @typedef {Object} SidechatSimpleAsset
54
+ * @prop {String} id - alphanumeric ID of asset
55
+ * @prop {"image"} type - undocumented
56
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
57
+ * @prop {Number} width - width of asset
58
+ * @prop {Number} height - height of asset
59
+ * @prop {SidechatPrivateAssetURL} [url] - URL string of asset's location
60
+ */
61
+
62
+ /**
63
+ * An asset object, containing information about an image from the asset library
64
+ * @typedef {Object} SidechatLibraryAsset
65
+ * @prop {String} id - alphanumeric ID of asset
66
+ * @prop {String} created_at - date string of asset creation time
67
+ * @prop {SidechatAssetMetadata} metadata - metadata associated with asset
68
+ * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
69
+ */
70
+
71
+ /**
72
+ * An asset object, containing information about an image from the asset library
73
+ * @typedef {Object} SidechatAssetMetadata
74
+ * @prop {Number} width - width of asset
75
+ * @prop {Number} height - height of asset
76
+ * @prop {"image"} type - undocumented
77
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
78
+ */
79
+
80
+ /**
81
+ * A user's anonymous identity information
82
+ * @typedef {Object} SidechatIdentity
83
+ * @prop {String} name - representation of user's name (varies across app)
84
+ * @prop {Boolean} posted_with_username - undocumented
85
+ */
86
+
87
+ /**
88
+ * A conversation icon associated with a user
89
+ * @typedef {Object} SidechatIcon
90
+ * @prop {String} emoji - unicode emoji character
91
+ * @prop {String} color - primary hex color code
92
+ * @prop {String} secondary_color - secondary hex color code
93
+ */
94
+
95
+ /**
96
+ * The current user's information
97
+ * @typedef {Object} SidechatCurrentUser
98
+ * @prop {String} id - alphanumeric ID of current user
99
+ * @prop {String} hashedVerifiedEmail - verified email of current user in an unreadable hashed form
100
+ * @prop {Boolean} isGlobalModerator - whether or not user is a moderator
101
+ * @prop {Boolean} isGlobalAdmin - whether or not user is an admin
102
+ * @prop {SidechatMembership[]} memberships
103
+ * @prop {Array} roles - undocumented
104
+ * @prop {String} emailDomain - domain of verified email address on account
105
+ * @prop {String} wildcardEmailDomain - domain of verified email address on account, preceeded by *. to support subdomains
106
+ */
107
+
108
+ /**
109
+ * A user's public profile
110
+ * @typedef {Object} SidechatProfile
111
+ * @prop {String} id - alphanumeric ID of user
112
+ * @prop {String} name - public-facing username
113
+ * @prop {SidechatIcon} conversation_icon - icon associated with user
114
+ * @prop {Boolean} description - the user bio
115
+ * @prop {String} index_name - undocumented
116
+ * @prop {String} analytics_name - undocumented
117
+ * @prop {String} color - undocumented
118
+ * @prop {String} share_color_start - undocumented
119
+ * @prop {String} share_color_end - undocumented
120
+ * @prop {"account"} group_join_type - undocumented
121
+ * @prop {"public_to_all"} group_visibility - the profile visibility status
122
+ */
123
+
124
+ /**
125
+ * Representation of a group membership
126
+ * @typedef {Object} SidechatMembership
127
+ * @prop {String} groupId - alphanumeric ID of group
128
+ * @prop {String} type - role of current user in group
129
+ */
130
+
131
+ /**
132
+ * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
133
+ * @typedef {String} SidechatPrivateAssetURL
134
+ */
135
+
136
+ /**
137
+ * A cursor for paginating through post lists
138
+ * @typedef {String} SidechatCursorString
139
+ */
140
+
141
+ /**
142
+ * A vote on a comment or post
143
+ * @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
144
+ */
145
+
146
+ /**
147
+ * A user's bearer authentication token needed for most requests
148
+ * @typedef {String} SidechatAuthToken
149
+ */
150
+
151
+ /**
152
+ * A list of posts and the associated cursor
153
+ * @typedef {Object} SidechatPostsAndCursor
154
+ * @prop {SidechatPostOrComment[]} posts
155
+ * @prop {SidechatCursorString} cursor
156
+ */
157
+
158
+
159
+ /**
160
+ * A direct message thread
161
+ * @typedef {Object} SidechatDirectThread
162
+ * @prop {String} id - alphanumeric ID of thread
163
+ * @prop {String} group_id - alphanumeric ID of group in which the thread exists
164
+ * @prop {String} updated_at - date string of when the last message in the chat was sent
165
+ * @prop {String} post_id - post or comment from which the thread was originally sent
166
+ * @prop {String} post_context - the context of the DM thread (only "feed" is known at the moment)
167
+ * @prop {"accepted"} accept_status - whether or not the other user has accepted this DM
168
+ * @prop {"post"|"comment"} type - the type of the content from which the DM was originally sent
169
+ * @prop {SidechatDirectMessage[]} messages - array of direct message objects
170
+ */
171
+
172
+ /**
173
+ * A single direct message
174
+ * @typedef {Object} SidechatDirectMessage
175
+ * @prop {String} created_at - time at which the message was sent
176
+ * @prop {String} client_id - alphanumeric ID of the device the message was sent on
177
+ * @prop {String} obfuscatedUserId - obfuscated version of the sender's alphanumeric ID
178
+ * @prop {String} text - body text of the message
179
+ * @prop {String} id - alphanumeric ID of the message
180
+ * @prop {String} chat_id - alphanumeric ID of the thread in which the message resides
181
+ * @prop {Boolean} authored_by_user - whether or not the current user sent the message
182
+ * @prop {"message"} type - undocumented
183
+ */
184
+
185
+ /**
186
+ * Represents a poll with choices
187
+ * @typedef {Object} SidechatPoll
188
+ * @prop {String} id - alphanumeric ID of poll
189
+ * @prop {String} post_id - alphanumeric ID of post to which poll is attached
190
+ * @prop {SidechatPollChoice[]} choices - array of poll choices
191
+ * @prop {Boolean} allows_view_results - whether or not poll results are publicly visible
192
+ * @prop {Number} view_results_count - number of users who have viewed poll results
193
+ * @prop {Boolean} participated - whether or not current user has voted in poll
194
+ */
195
+
196
+ /**
197
+ * Represents a poll choice
198
+ * @typedef {Object} SidechatPollChoice
199
+ * @prop {Number} count - number of votes for choice
200
+ * @prop {String} text - user-visible text of choice
201
+ * @prop {Boolean} selected - whether or not current user has voted for choice
202
+ */
203
+
204
+ export default {};</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">sidechat.js</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/sidechat.js" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/sidechat.js" target="_blank">NPM</a></div><div class="navbar-item"><a id="" href="https://offsides.micahlindley.com" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div><div class="sidebar-section-children"><a href="SidechatColorList.html">SidechatColorList</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatColor">SidechatColor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCurrentUser">SidechatCurrentUser</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectMessage">SidechatDirectMessage</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectThread">SidechatDirectThread</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIcon">SidechatIcon</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatMembership">SidechatMembership</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPoll">SidechatPoll</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPollChoice">SidechatPollChoice</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatProfile">SidechatProfile</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sidechat.js",
3
- "version": "2.5.6",
3
+ "version": "2.6.1",
4
4
  "description": "A reverse-engineered API wrapper for Sidechat",
5
5
  "type": "module",
6
6
  "source": "./src/index.js",
package/src/classes/SidechatAPIClient.js CHANGED
@@ -543,6 +543,33 @@ class SidechatAPIClient {
543
543
  }
544
544
  };
545
545
 
546
+ /**
547
+ * Searches for new groups based on a query keyword
548
+ * @method
549
+ * @since 2.6.0
550
+ * @param {String} query - the string to search for. This will be encoded, so strings with spaces and special characters are okay.
551
+ * @returns {SidechatGroup[]}
552
+ */
553
+ searchAvailableGroups = async (query) => {
554
+ if (!this.userToken) {
555
+ throw new SidechatAPIError("User is not authenticated.");
556
+ }
557
+ try {
558
+ const res = await fetch(`${this.apiRoot}/v1/groups/explore/search?term=${encodeURIComponent(query)}`, {
559
+ method: "GET",
560
+ headers: {
561
+ ...this.defaultHeaders,
562
+ Authorization: `Bearer ${this.userToken}`,
563
+ },
564
+ });
565
+ const json = await res.json();
566
+ return await json.results;
567
+ } catch (err) {
568
+ console.error(err);
569
+ throw new SidechatAPIError(`Failed to search groups.`);
570
+ }
571
+ };
572
+
546
573
  /**
547
574
  * Retrieves the entire accessible asset library. Be warned that as of the time of this documentation, it's a 1.5MB JSON download and this request is very expensive.
548
575
  * @method
@@ -727,7 +754,8 @@ class SidechatAPIClient {
727
754
  assetList = [],
728
755
  disableDMs = false,
729
756
  disableComments = false,
730
- anonymous = false
757
+ anonymous = false,
758
+ repostId = undefined
731
759
  ) => {
732
760
  if (!this.userToken) {
733
761
  throw new SidechatAPIError("User is not authenticated.");
@@ -748,6 +776,7 @@ class SidechatAPIClient {
748
776
  dms_disabled: disableDMs,
749
777
  comments_disabled: disableComments,
750
778
  using_identity: !anonymous,
779
+ quote_post_id: repostId
751
780
  }),
752
781
  });
753
782
  const json = await res.json();
@@ -1028,6 +1057,60 @@ class SidechatAPIClient {
1028
1057
  }
1029
1058
  };
1030
1059
 
1060
+ /**
1061
+ * Fetches a public user profile
1062
+ * @method
1063
+ * @since 2.6.0
1064
+ * @param {String} username - username of the user to fetch
1065
+ * @returns {SidechatProfile}
1066
+ */
1067
+ getUserProfile = async (username) => {
1068
+ if (!this.userToken) {
1069
+ throw new SidechatAPIError("User is not authenticated.");
1070
+ }
1071
+ try {
1072
+ const res = await fetch(`${this.apiRoot}/v1/groups/username?username=${username}`, {
1073
+ method: "GET",
1074
+ headers: {
1075
+ ...this.defaultHeaders,
1076
+ Authorization: `Bearer ${this.userToken}`,
1077
+ }
1078
+ });
1079
+ const json = await res.json();
1080
+ return await json.group;
1081
+ } catch (err) {
1082
+ console.error(err);
1083
+ throw new SidechatAPIError(`Failed to set icon.`);
1084
+ }
1085
+ };
1086
+
1087
+ /**
1088
+ * Fetches a public user's posts
1089
+ * @method
1090
+ * @since 2.6.0
1091
+ * @param {String} username - username of the user to fetch
1092
+ * @returns {SidechatPostOrComment[]}
1093
+ */
1094
+ getUserPosts = async (username) => {
1095
+ if (!this.userToken) {
1096
+ throw new SidechatAPIError("User is not authenticated.");
1097
+ }
1098
+ try {
1099
+ const res = await fetch(`${this.apiRoot}/v1/users/posts?username=${username}`, {
1100
+ method: "GET",
1101
+ headers: {
1102
+ ...this.defaultHeaders,
1103
+ Authorization: `Bearer ${this.userToken}`,
1104
+ }
1105
+ });
1106
+ const json = await res.json();
1107
+ return await json.posts;
1108
+ } catch (err) {
1109
+ console.error(err);
1110
+ throw new SidechatAPIError(`Failed to set icon.`);
1111
+ }
1112
+ };
1113
+
1031
1114
  /**
1032
1115
  * Marks an activity item as read
1033
1116
  * @method
@@ -1083,8 +1166,13 @@ class SidechatAPIClient {
1083
1166
  };
1084
1167
 
1085
1168
  /**
1086
- * Joins a group chat
1169
+ * Joins a group chat. To mimic the official client, use the user's display name and icon by default.
1087
1170
  * @method
1171
+ * @param {String} groupChatID - alphanumeric ID of group chat to join
1172
+ * @param {String} displayName - display name to use in chat
1173
+ * @param {String} emoji - emoji to use as icon
1174
+ * @param {String} primaryColor - hex string of primary color
1175
+ * @param {String} secondaryColor - hex string of secondary color
1088
1176
  * @since 2.3.5
1089
1177
  */
1090
1178
  joinGroupChat = async (
package/src/types/SidechatTypes.js CHANGED
@@ -3,7 +3,7 @@
3
3
  * @typedef {Object} SidechatPostOrComment
4
4
  * @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
5
5
  * @prop {String} id - alphanumeric ID of post or comment
6
- * @prop {Boolean} authored_by_user - undocumented
6
+ * @prop {Boolean} authored_by_user - whether or not the post or comment was created by the current user
7
7
  * @prop {String} alias - post creator's name in-app
8
8
  * @prop {String} group_id - alphanumeric ID of group
9
9
  * @prop {SidechatGroup} group - group in which post or comment was created
@@ -17,8 +17,8 @@
17
17
  * @prop {String[]} tags - undocumented
18
18
  * @prop {SidechatIdentity} identity - creator's identity information
19
19
  * @prop {Boolean} pinned - undocumented
20
- * @prop {Boolean} is_saved - undocumented
21
- * @prop {"following"|"not_following"} follow_status - undocumented
20
+ * @prop {Boolean} is_saved - whether or not the current user has saved the post
21
+ * @prop {"following"|"not_following"} follow_status - whether or not the current user should recieve activity notifications for the post
22
22
  * @prop {"group"} [destination] - undocumented
23
23
  * @prop {Number} [comment_count] - number of comments on post (only if type=post)
24
24
  * @prop {Boolean} [comments_disabled] - whether or not you can comment on post (only if type=post)
@@ -82,6 +82,14 @@
82
82
  * @prop {Boolean} posted_with_username - undocumented
83
83
  */
84
84
 
85
+ /**
86
+ * A conversation icon associated with a user
87
+ * @typedef {Object} SidechatIcon
88
+ * @prop {String} emoji - unicode emoji character
89
+ * @prop {String} color - primary hex color code
90
+ * @prop {String} secondary_color - secondary hex color code
91
+ */
92
+
85
93
  /**
86
94
  * The current user's information
87
95
  * @typedef {Object} SidechatCurrentUser
@@ -95,6 +103,22 @@
95
103
  * @prop {String} wildcardEmailDomain - domain of verified email address on account, preceeded by *. to support subdomains
96
104
  */
97
105
 
106
+ /**
107
+ * A user's public profile
108
+ * @typedef {Object} SidechatProfile
109
+ * @prop {String} id - alphanumeric ID of user
110
+ * @prop {String} name - public-facing username
111
+ * @prop {SidechatIcon} conversation_icon - icon associated with user
112
+ * @prop {Boolean} description - the user bio
113
+ * @prop {String} index_name - undocumented
114
+ * @prop {String} analytics_name - undocumented
115
+ * @prop {String} color - undocumented
116
+ * @prop {String} share_color_start - undocumented
117
+ * @prop {String} share_color_end - undocumented
118
+ * @prop {"account"} group_join_type - undocumented
119
+ * @prop {"public_to_all"} group_visibility - the profile visibility status
120
+ */
121
+
98
122
  /**
99
123
  * Representation of a group membership
100
124
  * @typedef {Object} SidechatMembership
@@ -129,7 +153,6 @@
129
153
  * @prop {SidechatCursorString} cursor
130
154
  */
131
155
 
132
- export default {};
133
156
 
134
157
  /**
135
158
  * A direct message thread
@@ -166,7 +189,7 @@ export default {};
166
189
  * @prop {Boolean} allows_view_results - whether or not poll results are publicly visible
167
190
  * @prop {Number} view_results_count - number of users who have viewed poll results
168
191
  * @prop {Boolean} participated - whether or not current user has voted in poll
169
- */
192
+ */
170
193
 
171
194
  /**
172
195
  * Represents a poll choice
@@ -174,4 +197,6 @@ export default {};
174
197
  * @prop {Number} count - number of votes for choice
175
198
  * @prop {String} text - user-visible text of choice
176
199
  * @prop {Boolean} selected - whether or not current user has voted for choice
177
- */
200
+ */
201
+
202
+ export default {};