sidechat.js 2.3.6 → 2.3.8

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 (269) hide show
  1. package/dist/classes/SidechatAPIClient.d.ts +8 -0
  2. package/dist/classes/SidechatAPIClient.d.ts.map +1 -1
  3. package/dist/classes/SidechatColorList.d.ts +7 -5
  4. package/dist/classes/SidechatColorList.d.ts.map +1 -1
  5. package/dist/index.cjs +39 -7
  6. package/dist/index.mjs +39 -7
  7. package/docs/sidechat.js/2.3.8/SidechatAPIClient.html +3 -0
  8. package/docs/sidechat.js/2.3.8/SidechatAPIError.html +3 -0
  9. package/docs/sidechat.js/{2.2.0/classes_SidechatAPIError.js.html → 2.3.8/SidechatColorList.html} +2 -15
  10. package/docs/sidechat.js/{2.3.1 → 2.3.8}/classes_SidechatAPIClient.js.html +237 -6
  11. package/docs/sidechat.js/{2.0.4 → 2.3.8}/classes_SidechatAPIError.js.html +2 -2
  12. package/docs/sidechat.js/{2.0.6/classes_SidechatAPIError.js.html → 2.3.8/classes_SidechatColorList.js.html} +75 -12
  13. package/docs/sidechat.js/2.3.8/data/search.json +1 -0
  14. package/docs/sidechat.js/2.3.8/global.html +3 -0
  15. package/docs/sidechat.js/{2.2.0 → 2.3.8}/index.html +2 -2
  16. package/docs/sidechat.js/{2.0.4 → 2.3.8}/tutorial-Authentication.html +4 -3
  17. package/docs/sidechat.js/{2.0.4 → 2.3.8}/tutorial-Email Registration.html +2 -2
  18. package/docs/sidechat.js/{2.2.1 → 2.3.8}/types_SidechatTypes.js.html +2 -2
  19. package/package.json +1 -1
  20. package/src/classes/SidechatAPIClient.js +34 -1
  21. package/src/classes/SidechatColorList.js +5 -6
  22. package/docs/sidechat.js/2.0.4/SidechatAPIClient.html +0 -3
  23. package/docs/sidechat.js/2.0.4/SidechatAPIError.html +0 -3
  24. package/docs/sidechat.js/2.0.4/classes_SidechatAPIClient.js.html +0 -425
  25. package/docs/sidechat.js/2.0.4/data/search.json +0 -1
  26. package/docs/sidechat.js/2.0.4/global.html +0 -3
  27. package/docs/sidechat.js/2.0.4/index.html +0 -4
  28. package/docs/sidechat.js/2.0.4/types_SidechatTypes.js.html +0 -98
  29. package/docs/sidechat.js/2.0.6/SidechatAPIClient.html +0 -3
  30. package/docs/sidechat.js/2.0.6/SidechatAPIError.html +0 -3
  31. package/docs/sidechat.js/2.0.6/classes_SidechatAPIClient.js.html +0 -462
  32. package/docs/sidechat.js/2.0.6/data/search.json +0 -1
  33. package/docs/sidechat.js/2.0.6/fonts/Inconsolata-Regular.ttf +0 -0
  34. package/docs/sidechat.js/2.0.6/fonts/OpenSans-Regular.ttf +0 -0
  35. package/docs/sidechat.js/2.0.6/fonts/WorkSans-Bold.ttf +0 -0
  36. package/docs/sidechat.js/2.0.6/global.html +0 -3
  37. package/docs/sidechat.js/2.0.6/index.html +0 -4
  38. package/docs/sidechat.js/2.0.6/scripts/core.js +0 -702
  39. package/docs/sidechat.js/2.0.6/scripts/core.min.js +0 -23
  40. package/docs/sidechat.js/2.0.6/scripts/resize.js +0 -90
  41. package/docs/sidechat.js/2.0.6/scripts/search.js +0 -265
  42. package/docs/sidechat.js/2.0.6/scripts/search.min.js +0 -6
  43. package/docs/sidechat.js/2.0.6/scripts/third-party/Apache-License-2.0.txt +0 -202
  44. package/docs/sidechat.js/2.0.6/scripts/third-party/fuse.js +0 -9
  45. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-line-num-original.js +0 -369
  46. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-line-num.js +0 -1
  47. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-original.js +0 -5171
  48. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs.js +0 -1
  49. package/docs/sidechat.js/2.0.6/scripts/third-party/popper.js +0 -5
  50. package/docs/sidechat.js/2.0.6/scripts/third-party/tippy.js +0 -1
  51. package/docs/sidechat.js/2.0.6/scripts/third-party/tocbot.js +0 -672
  52. package/docs/sidechat.js/2.0.6/scripts/third-party/tocbot.min.js +0 -1
  53. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-base.css +0 -975
  54. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-dark.css +0 -407
  55. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-light.css +0 -388
  56. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme.min.css +0 -1
  57. package/docs/sidechat.js/2.0.6/tutorial-Authentication.html +0 -13
  58. package/docs/sidechat.js/2.0.6/tutorial-Email Registration.html +0 -6
  59. package/docs/sidechat.js/2.0.6/types_SidechatTypes.js.html +0 -114
  60. package/docs/sidechat.js/2.1.0/SidechatAPIClient.html +0 -3
  61. package/docs/sidechat.js/2.1.0/SidechatAPIError.html +0 -3
  62. package/docs/sidechat.js/2.1.0/classes_SidechatAPIClient.js.html +0 -528
  63. package/docs/sidechat.js/2.1.0/classes_SidechatAPIError.js.html +0 -16
  64. package/docs/sidechat.js/2.1.0/data/search.json +0 -1
  65. package/docs/sidechat.js/2.1.0/fonts/Inconsolata-Regular.ttf +0 -0
  66. package/docs/sidechat.js/2.1.0/fonts/OpenSans-Regular.ttf +0 -0
  67. package/docs/sidechat.js/2.1.0/fonts/WorkSans-Bold.ttf +0 -0
  68. package/docs/sidechat.js/2.1.0/global.html +0 -3
  69. package/docs/sidechat.js/2.1.0/index.html +0 -4
  70. package/docs/sidechat.js/2.1.0/scripts/core.js +0 -702
  71. package/docs/sidechat.js/2.1.0/scripts/core.min.js +0 -23
  72. package/docs/sidechat.js/2.1.0/scripts/resize.js +0 -90
  73. package/docs/sidechat.js/2.1.0/scripts/search.js +0 -265
  74. package/docs/sidechat.js/2.1.0/scripts/search.min.js +0 -6
  75. package/docs/sidechat.js/2.1.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  76. package/docs/sidechat.js/2.1.0/scripts/third-party/fuse.js +0 -9
  77. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-line-num-original.js +0 -369
  78. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-line-num.js +0 -1
  79. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-original.js +0 -5171
  80. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs.js +0 -1
  81. package/docs/sidechat.js/2.1.0/scripts/third-party/popper.js +0 -5
  82. package/docs/sidechat.js/2.1.0/scripts/third-party/tippy.js +0 -1
  83. package/docs/sidechat.js/2.1.0/scripts/third-party/tocbot.js +0 -672
  84. package/docs/sidechat.js/2.1.0/scripts/third-party/tocbot.min.js +0 -1
  85. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-base.css +0 -975
  86. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-dark.css +0 -407
  87. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-light.css +0 -388
  88. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme.min.css +0 -1
  89. package/docs/sidechat.js/2.1.0/tutorial-Authentication.html +0 -13
  90. package/docs/sidechat.js/2.1.0/tutorial-Email Registration.html +0 -6
  91. package/docs/sidechat.js/2.1.0/types_SidechatTypes.js.html +0 -134
  92. package/docs/sidechat.js/2.2.0/SidechatAPIClient.html +0 -3
  93. package/docs/sidechat.js/2.2.0/SidechatAPIError.html +0 -3
  94. package/docs/sidechat.js/2.2.0/classes_SidechatAPIClient.js.html +0 -651
  95. package/docs/sidechat.js/2.2.0/data/search.json +0 -1
  96. package/docs/sidechat.js/2.2.0/fonts/Inconsolata-Regular.ttf +0 -0
  97. package/docs/sidechat.js/2.2.0/fonts/OpenSans-Regular.ttf +0 -0
  98. package/docs/sidechat.js/2.2.0/fonts/WorkSans-Bold.ttf +0 -0
  99. package/docs/sidechat.js/2.2.0/global.html +0 -3
  100. package/docs/sidechat.js/2.2.0/scripts/core.js +0 -702
  101. package/docs/sidechat.js/2.2.0/scripts/core.min.js +0 -23
  102. package/docs/sidechat.js/2.2.0/scripts/resize.js +0 -90
  103. package/docs/sidechat.js/2.2.0/scripts/search.js +0 -265
  104. package/docs/sidechat.js/2.2.0/scripts/search.min.js +0 -6
  105. package/docs/sidechat.js/2.2.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  106. package/docs/sidechat.js/2.2.0/scripts/third-party/fuse.js +0 -9
  107. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-line-num-original.js +0 -369
  108. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-line-num.js +0 -1
  109. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-original.js +0 -5171
  110. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs.js +0 -1
  111. package/docs/sidechat.js/2.2.0/scripts/third-party/popper.js +0 -5
  112. package/docs/sidechat.js/2.2.0/scripts/third-party/tippy.js +0 -1
  113. package/docs/sidechat.js/2.2.0/scripts/third-party/tocbot.js +0 -672
  114. package/docs/sidechat.js/2.2.0/scripts/third-party/tocbot.min.js +0 -1
  115. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-base.css +0 -975
  116. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-dark.css +0 -407
  117. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-light.css +0 -388
  118. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme.min.css +0 -1
  119. package/docs/sidechat.js/2.2.0/tutorial-Authentication.html +0 -14
  120. package/docs/sidechat.js/2.2.0/tutorial-Email Registration.html +0 -6
  121. package/docs/sidechat.js/2.2.0/types_SidechatTypes.js.html +0 -134
  122. package/docs/sidechat.js/2.2.1/SidechatAPIClient.html +0 -3
  123. package/docs/sidechat.js/2.2.1/SidechatAPIError.html +0 -3
  124. package/docs/sidechat.js/2.2.1/classes_SidechatAPIClient.js.html +0 -688
  125. package/docs/sidechat.js/2.2.1/classes_SidechatAPIError.js.html +0 -16
  126. package/docs/sidechat.js/2.2.1/data/search.json +0 -1
  127. package/docs/sidechat.js/2.2.1/fonts/Inconsolata-Regular.ttf +0 -0
  128. package/docs/sidechat.js/2.2.1/fonts/OpenSans-Regular.ttf +0 -0
  129. package/docs/sidechat.js/2.2.1/fonts/WorkSans-Bold.ttf +0 -0
  130. package/docs/sidechat.js/2.2.1/global.html +0 -3
  131. package/docs/sidechat.js/2.2.1/index.html +0 -4
  132. package/docs/sidechat.js/2.2.1/scripts/core.js +0 -702
  133. package/docs/sidechat.js/2.2.1/scripts/core.min.js +0 -23
  134. package/docs/sidechat.js/2.2.1/scripts/resize.js +0 -90
  135. package/docs/sidechat.js/2.2.1/scripts/search.js +0 -265
  136. package/docs/sidechat.js/2.2.1/scripts/search.min.js +0 -6
  137. package/docs/sidechat.js/2.2.1/scripts/third-party/Apache-License-2.0.txt +0 -202
  138. package/docs/sidechat.js/2.2.1/scripts/third-party/fuse.js +0 -9
  139. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-line-num-original.js +0 -369
  140. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-line-num.js +0 -1
  141. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-original.js +0 -5171
  142. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs.js +0 -1
  143. package/docs/sidechat.js/2.2.1/scripts/third-party/popper.js +0 -5
  144. package/docs/sidechat.js/2.2.1/scripts/third-party/tippy.js +0 -1
  145. package/docs/sidechat.js/2.2.1/scripts/third-party/tocbot.js +0 -672
  146. package/docs/sidechat.js/2.2.1/scripts/third-party/tocbot.min.js +0 -1
  147. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-base.css +0 -975
  148. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-dark.css +0 -407
  149. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-light.css +0 -388
  150. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme.min.css +0 -1
  151. package/docs/sidechat.js/2.2.1/tutorial-Authentication.html +0 -14
  152. package/docs/sidechat.js/2.2.1/tutorial-Email Registration.html +0 -6
  153. package/docs/sidechat.js/2.2.3/SidechatAPIClient.html +0 -3
  154. package/docs/sidechat.js/2.2.3/SidechatAPIError.html +0 -3
  155. package/docs/sidechat.js/2.2.3/classes_SidechatAPIClient.js.html +0 -689
  156. package/docs/sidechat.js/2.2.3/classes_SidechatAPIError.js.html +0 -16
  157. package/docs/sidechat.js/2.2.3/data/search.json +0 -1
  158. package/docs/sidechat.js/2.2.3/fonts/Inconsolata-Regular.ttf +0 -0
  159. package/docs/sidechat.js/2.2.3/fonts/OpenSans-Regular.ttf +0 -0
  160. package/docs/sidechat.js/2.2.3/fonts/WorkSans-Bold.ttf +0 -0
  161. package/docs/sidechat.js/2.2.3/global.html +0 -3
  162. package/docs/sidechat.js/2.2.3/index.html +0 -4
  163. package/docs/sidechat.js/2.2.3/scripts/core.js +0 -702
  164. package/docs/sidechat.js/2.2.3/scripts/core.min.js +0 -23
  165. package/docs/sidechat.js/2.2.3/scripts/resize.js +0 -90
  166. package/docs/sidechat.js/2.2.3/scripts/search.js +0 -265
  167. package/docs/sidechat.js/2.2.3/scripts/search.min.js +0 -6
  168. package/docs/sidechat.js/2.2.3/scripts/third-party/Apache-License-2.0.txt +0 -202
  169. package/docs/sidechat.js/2.2.3/scripts/third-party/fuse.js +0 -9
  170. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-line-num-original.js +0 -369
  171. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-line-num.js +0 -1
  172. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-original.js +0 -5171
  173. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs.js +0 -1
  174. package/docs/sidechat.js/2.2.3/scripts/third-party/popper.js +0 -5
  175. package/docs/sidechat.js/2.2.3/scripts/third-party/tippy.js +0 -1
  176. package/docs/sidechat.js/2.2.3/scripts/third-party/tocbot.js +0 -672
  177. package/docs/sidechat.js/2.2.3/scripts/third-party/tocbot.min.js +0 -1
  178. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-base.css +0 -975
  179. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-dark.css +0 -407
  180. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-light.css +0 -388
  181. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme.min.css +0 -1
  182. package/docs/sidechat.js/2.2.3/tutorial-Authentication.html +0 -14
  183. package/docs/sidechat.js/2.2.3/tutorial-Email Registration.html +0 -6
  184. package/docs/sidechat.js/2.2.3/types_SidechatTypes.js.html +0 -134
  185. package/docs/sidechat.js/2.3.0/SidechatAPIClient.html +0 -3
  186. package/docs/sidechat.js/2.3.0/SidechatAPIError.html +0 -3
  187. package/docs/sidechat.js/2.3.0/classes_SidechatAPIClient.js.html +0 -720
  188. package/docs/sidechat.js/2.3.0/classes_SidechatAPIError.js.html +0 -16
  189. package/docs/sidechat.js/2.3.0/data/search.json +0 -1
  190. package/docs/sidechat.js/2.3.0/fonts/Inconsolata-Regular.ttf +0 -0
  191. package/docs/sidechat.js/2.3.0/fonts/OpenSans-Regular.ttf +0 -0
  192. package/docs/sidechat.js/2.3.0/fonts/WorkSans-Bold.ttf +0 -0
  193. package/docs/sidechat.js/2.3.0/global.html +0 -3
  194. package/docs/sidechat.js/2.3.0/index.html +0 -4
  195. package/docs/sidechat.js/2.3.0/scripts/core.js +0 -702
  196. package/docs/sidechat.js/2.3.0/scripts/core.min.js +0 -23
  197. package/docs/sidechat.js/2.3.0/scripts/resize.js +0 -90
  198. package/docs/sidechat.js/2.3.0/scripts/search.js +0 -265
  199. package/docs/sidechat.js/2.3.0/scripts/search.min.js +0 -6
  200. package/docs/sidechat.js/2.3.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  201. package/docs/sidechat.js/2.3.0/scripts/third-party/fuse.js +0 -9
  202. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-line-num-original.js +0 -369
  203. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-line-num.js +0 -1
  204. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-original.js +0 -5171
  205. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs.js +0 -1
  206. package/docs/sidechat.js/2.3.0/scripts/third-party/popper.js +0 -5
  207. package/docs/sidechat.js/2.3.0/scripts/third-party/tippy.js +0 -1
  208. package/docs/sidechat.js/2.3.0/scripts/third-party/tocbot.js +0 -672
  209. package/docs/sidechat.js/2.3.0/scripts/third-party/tocbot.min.js +0 -1
  210. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-base.css +0 -975
  211. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-dark.css +0 -407
  212. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-light.css +0 -388
  213. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme.min.css +0 -1
  214. package/docs/sidechat.js/2.3.0/tutorial-Authentication.html +0 -14
  215. package/docs/sidechat.js/2.3.0/tutorial-Email Registration.html +0 -6
  216. package/docs/sidechat.js/2.3.0/types_SidechatTypes.js.html +0 -134
  217. package/docs/sidechat.js/2.3.1/SidechatAPIClient.html +0 -3
  218. package/docs/sidechat.js/2.3.1/SidechatAPIError.html +0 -3
  219. package/docs/sidechat.js/2.3.1/classes_SidechatAPIError.js.html +0 -16
  220. package/docs/sidechat.js/2.3.1/data/search.json +0 -1
  221. package/docs/sidechat.js/2.3.1/fonts/Inconsolata-Regular.ttf +0 -0
  222. package/docs/sidechat.js/2.3.1/fonts/OpenSans-Regular.ttf +0 -0
  223. package/docs/sidechat.js/2.3.1/fonts/WorkSans-Bold.ttf +0 -0
  224. package/docs/sidechat.js/2.3.1/global.html +0 -3
  225. package/docs/sidechat.js/2.3.1/index.html +0 -4
  226. package/docs/sidechat.js/2.3.1/scripts/core.js +0 -702
  227. package/docs/sidechat.js/2.3.1/scripts/core.min.js +0 -23
  228. package/docs/sidechat.js/2.3.1/scripts/resize.js +0 -90
  229. package/docs/sidechat.js/2.3.1/scripts/search.js +0 -265
  230. package/docs/sidechat.js/2.3.1/scripts/search.min.js +0 -6
  231. package/docs/sidechat.js/2.3.1/scripts/third-party/Apache-License-2.0.txt +0 -202
  232. package/docs/sidechat.js/2.3.1/scripts/third-party/fuse.js +0 -9
  233. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-line-num-original.js +0 -369
  234. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-line-num.js +0 -1
  235. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-original.js +0 -5171
  236. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs.js +0 -1
  237. package/docs/sidechat.js/2.3.1/scripts/third-party/popper.js +0 -5
  238. package/docs/sidechat.js/2.3.1/scripts/third-party/tippy.js +0 -1
  239. package/docs/sidechat.js/2.3.1/scripts/third-party/tocbot.js +0 -672
  240. package/docs/sidechat.js/2.3.1/scripts/third-party/tocbot.min.js +0 -1
  241. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-base.css +0 -975
  242. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-dark.css +0 -407
  243. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-light.css +0 -388
  244. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme.min.css +0 -1
  245. package/docs/sidechat.js/2.3.1/tutorial-Authentication.html +0 -14
  246. package/docs/sidechat.js/2.3.1/tutorial-Email Registration.html +0 -6
  247. package/docs/sidechat.js/2.3.1/types_SidechatTypes.js.html +0 -134
  248. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/fonts/Inconsolata-Regular.ttf +0 -0
  249. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/fonts/OpenSans-Regular.ttf +0 -0
  250. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/fonts/WorkSans-Bold.ttf +0 -0
  251. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/core.js +0 -0
  252. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/core.min.js +0 -0
  253. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/resize.js +0 -0
  254. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/search.js +0 -0
  255. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/search.min.js +0 -0
  256. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/Apache-License-2.0.txt +0 -0
  257. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/fuse.js +0 -0
  258. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/hljs-line-num-original.js +0 -0
  259. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/hljs-line-num.js +0 -0
  260. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/hljs-original.js +0 -0
  261. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/hljs.js +0 -0
  262. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/popper.js +0 -0
  263. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/tippy.js +0 -0
  264. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/tocbot.js +0 -0
  265. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/tocbot.min.js +0 -0
  266. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/styles/clean-jsdoc-theme-base.css +0 -0
  267. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/styles/clean-jsdoc-theme-dark.css +0 -0
  268. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/styles/clean-jsdoc-theme-light.css +0 -0
  269. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/styles/clean-jsdoc-theme.min.css +0 -0
@@ -1,388 +0,0 @@
1
- .light ::selection {
2
- background: #ffce76;
3
- color: #1d1919;
4
- }
5
-
6
- body.light {
7
- background-color: #fff;
8
- color: #111;
9
- }
10
-
11
- .light a,
12
- .light a:active {
13
- color: #007bff;
14
- }
15
-
16
- .light hr {
17
- color: #f7f7f7;
18
- }
19
-
20
- .light h1,
21
- .light h2,
22
- .light h3,
23
- .light h4,
24
- .light h5,
25
- .light h6 {
26
- color: #111;
27
- }
28
-
29
- .light .sidebar {
30
- background-color: #f7f7f7;
31
- color: #222;
32
- }
33
-
34
- .light .sidebar-title {
35
- color: #222;
36
- }
37
-
38
- .light .sidebar-section-title {
39
- color: #222;
40
- }
41
-
42
- .light .sidebar-section-title:hover {
43
- background: #eee;
44
- }
45
-
46
- .light .with-arrow {
47
- fill: #111;
48
- }
49
-
50
- .light .sidebar-section-children-container {
51
- background: #eee;
52
- }
53
-
54
- .light .sidebar-section-children a:hover {
55
- background: #e0e0e0;
56
- }
57
-
58
- .light .sidebar-section-children a {
59
- color: #111;
60
- }
61
-
62
- .light .navbar-container {
63
- background: #fff;
64
- }
65
-
66
- .light .icon-button svg,
67
- .light .navbar-item a {
68
- color: #222;
69
- fill: #222;
70
- }
71
-
72
- .light .tippy-box {
73
- background: #eee;
74
- color: #111;
75
- }
76
-
77
- .light .tippy-arrow {
78
- color: #f1f1f1;
79
- }
80
-
81
- .light .font-size-tooltip .icon-button svg {
82
- fill: #111;
83
- }
84
-
85
- .light .font-size-tooltip .icon-button.disabled svg {
86
- fill: #999;
87
- }
88
-
89
- .light .icon-button:hover {
90
- background: #ddd;
91
- }
92
-
93
- .light .icon-button:active {
94
- background: #ccc;
95
- }
96
-
97
- .light .navbar-item a:active {
98
- color: #333;
99
- background-color: #eee;
100
- }
101
-
102
- .light .navbar-item:hover {
103
- background: #f7f7f7;
104
- }
105
-
106
- .light .footer {
107
- background: #f7f7f7;
108
- color: #111;
109
- }
110
-
111
- .light .footer a {
112
- color: #111;
113
- }
114
-
115
- .light .toc-link {
116
- color: #999;
117
- transition: color 0.3s;
118
- font-size: 0.875rem;
119
- }
120
-
121
- .light .toc-link.is-active-link {
122
- color: #111;
123
- }
124
-
125
- .light .has-anchor .link-anchor {
126
- color: #ddd;
127
- }
128
-
129
- .light .has-anchor .link-anchor:hover {
130
- color: #ccc;
131
- }
132
-
133
- .light .signature-attributes {
134
- color: #aaa;
135
- }
136
-
137
- .light .ancestors {
138
- color: #999;
139
- }
140
-
141
- .light .ancestors a {
142
- color: #999 !important;
143
- }
144
-
145
- .light .important {
146
- color: #ee1313;
147
- }
148
-
149
- .light .type-signature {
150
- color: #00918e;
151
- }
152
-
153
- .light .name,
154
- .light .name a {
155
- color: #293a80;
156
- }
157
-
158
- .light .details {
159
- background: #f9f9f9;
160
- color: #101010;
161
- }
162
-
163
- .light .member-item-container strong,
164
- .light .method-member-container strong {
165
- color: #000;
166
- }
167
-
168
- .light .prettyprint {
169
- background: #f7f7f7;
170
- }
171
-
172
- .light .pre-div {
173
- background: #f7f7f7;
174
- }
175
-
176
- .light .hljs .hljs-ln-numbers {
177
- color: #aaa;
178
- }
179
-
180
- .light .hljs .selected {
181
- background: #ccc;
182
- }
183
-
184
- .light table.hljs-ln td {
185
- background: none;
186
- }
187
-
188
- .light .hljs .selected .hljs-ln-numbers {
189
- color: #444;
190
- }
191
-
192
- .light .pre-top-bar-container {
193
- background-color: #eee;
194
- }
195
-
196
- .light .prettyprint code {
197
- background-color: #f7f7f7;
198
- }
199
-
200
- .light table .name,
201
- .light .params .name,
202
- .light .props .name,
203
- .light .name code {
204
- color: #4d4e53;
205
- }
206
-
207
- .light table td,
208
- .light .params td {
209
- background: #f7f7f7;
210
- }
211
-
212
- .light table thead th,
213
- .light .params thead th,
214
- .light .props thead th {
215
- background-color: #eee;
216
- color: #111;
217
- }
218
-
219
- /* stylelint-disable */
220
- .light table .params thead tr,
221
- .light .params .params thead tr,
222
- .light .props .props thead tr {
223
- background-color: #eee;
224
- color: #111;
225
- }
226
-
227
- .light .disabled {
228
- color: #454545;
229
- }
230
-
231
- .light .code-lang-name {
232
- color: #ff0000;
233
- }
234
-
235
- .light .tooltip {
236
- background: #ffce76;
237
- color: #000;
238
- }
239
-
240
- /* Code */
241
-
242
- .light .hljs-comment,
243
- .light .hljs-quote {
244
- color: #a0a1a7;
245
- }
246
-
247
- .light .hljs-doctag,
248
- .light .hljs-keyword,
249
- .light .hljs-formula {
250
- color: #a626a4;
251
- }
252
-
253
- .light .hljs-section,
254
- .light .hljs-name,
255
- .light .hljs-selector-tag,
256
- .light .hljs-deletion,
257
- .light .hljs-subst {
258
- color: #e45649;
259
- }
260
-
261
- .light .hljs-literal {
262
- color: #0184bb;
263
- }
264
-
265
- .light .hljs-string,
266
- .light .hljs-regexp,
267
- .light .hljs-addition,
268
- .light .hljs-attribute,
269
- .light .hljs-meta .hljs-string {
270
- color: #50a14f;
271
- }
272
-
273
- .light .hljs-attr,
274
- .light .hljs-variable,
275
- .light .hljs-template-variable,
276
- .light .hljs-type,
277
- .light .hljs-selector-class,
278
- .light .hljs-selector-attr,
279
- .light .hljs-selector-pseudo,
280
- .light .hljs-number {
281
- color: #986801;
282
- }
283
-
284
- .light .hljs-symbol,
285
- .light .hljs-bullet,
286
- .light .hljs-link,
287
- .light .hljs-meta,
288
- .light .hljs-selector-id,
289
- .light .hljs-title {
290
- color: #4078f2;
291
- }
292
-
293
- .light .hljs-built_in,
294
- .light .hljs-title.class_,
295
- .light .hljs-class .hljs-title {
296
- color: #c18401;
297
- }
298
-
299
- .light .hljs-emphasis {
300
- font-style: italic;
301
- }
302
-
303
- .light .hljs-strong {
304
- font-weight: bold;
305
- }
306
-
307
- .light .hljs-link {
308
- text-decoration: underline;
309
- }
310
-
311
- /* Code Ends */
312
-
313
- .light blockquote {
314
- background: #eee;
315
- color: #111;
316
- }
317
-
318
- .light code {
319
- background: #ddd;
320
- color: #000;
321
- }
322
-
323
- .light .search-container {
324
- background: rgba(0, 0, 0, 0.1);
325
- }
326
-
327
- .light .search-close-button svg {
328
- fill: #f00;
329
- }
330
-
331
- .light .search-container .wrapper {
332
- background: #eee;
333
- }
334
-
335
- .light .search-result-c {
336
- color: #aaa;
337
- }
338
-
339
- .light .search-box-c svg {
340
- fill: #333;
341
- }
342
-
343
- .light .search-input {
344
- background: #f7f7f7;
345
- color: #111;
346
- }
347
-
348
- .light .search-result-item {
349
- background: #f7f7f7;
350
- }
351
-
352
- .light .search-result-item:hover {
353
- background: #e9e9e9;
354
- }
355
-
356
- .light .search-result-item:active {
357
- background: #f7f7f7;
358
- }
359
-
360
- .light .search-result-item-title {
361
- color: #111;
362
- }
363
-
364
- .light .search-result-item-p {
365
- color: #aaa;
366
- }
367
-
368
- .light .mobile-menu-icon-container .icon-button {
369
- background: #e5e5e5;
370
- }
371
-
372
- .light .mobile-sidebar-container {
373
- background: #fff;
374
- }
375
-
376
- .light .mobile-sidebar-wrapper {
377
- background: #f7f7f7;
378
- }
379
-
380
- /* scroll bar */
381
- .light ::-webkit-scrollbar-track {
382
- background: #ddd;
383
- }
384
-
385
- .light ::-webkit-scrollbar-thumb {
386
- background: #aaa;
387
- outline: 0.06125rem solid #aaa;
388
- }
@@ -1 +0,0 @@
1
- @font-face{font-family:"heading";src:url(../fonts/WorkSans-Bold.ttf)format("truetype");font-display:swap}@font-face{font-family:"body";src:url(../fonts/OpenSans-Regular.ttf)format("truetype");font-display:swap}@font-face{font-family:"code";src:url(../fonts/Inconsolata-Regular.ttf)format("truetype");font-display:swap}:root{--outer-wrapper-max-width:65rem}*{box-sizing:border-box;margin:0;padding:0}html,body{min-height:100%;width:100%;line-height:1.75}body{font-family:"body";overflow-x:hidden;position:relative}b{font-family:heading}h1,h2,h3,h4,h5,h6{font-family:"heading";font-weight:400;line-height:1.75}h1{font-size:3.5rem;margin:0}h2{font-size:2.25rem;margin:2rem 0 0}h3{font-size:1.5rem}h4{font-size:1.25rem}h5{font-size:1rem}h6{font-size:1rem}img{max-width:100%}a{text-decoration:none}a:hover{text-decoration:underline}a img{margin-right:.5rem}p{margin:1rem 0}article ul{list-style:none}article ul li,article ol li{padding:.5rem 0}article ol,article ul{padding-left:3rem}article ol p,article ul p{margin:0}.variation{display:none}.signature-attributes{font-style:italic;font-weight:lighter}.ancestors a{text-decoration:none}.important{font-weight:700}.signature{font-family:"code"}.name{font-family:"code";font-weight:700}blockquote{font-size:.875rem;padding:.0625rem 1.25rem;border-radius:1rem;margin:.5rem 0}.details{border-radius:1rem;margin:1rem 0}.details .details-item-container{display:flex;padding:1rem 2rem}dt{font-family:heading}.details dt{float:left;min-width:11rem}.details ul{margin:0;display:inline-flex;list-style-type:none}.details ul li{display:inline-flex;margin-right:.6125rem;padding:0;word-break:break-word}.details ul li p{margin:0}.details pre.prettyprint{margin:0}.details .object-value{padding-top:0}.description{margin-bottom:2rem}.method-member-container table{margin-top:1rem}.pre-div .hljs-ln{margin:0}.code-caption{font-size:.875rem}.prettyprint{font-size:.875rem;overflow:auto}pre.prettyprint{margin-top:3rem}.prettyprint.source{width:inherit}.prettyprint code{display:block;font-size:1rem;line-height:1.75;padding:0 0 1rem}.prettyprint .compact{padding:0}h4.name{margin-top:.5rem}.params,.props,table{border-collapse:separate;border-spacing:0 .5rem;border-radius:.5rem;font-size:.875rem;margin:0;width:100%}table td:first-child,.params td:first-child,table thead th:first-child,.params thead th:first-child,.props thead th:first-child{border-top-left-radius:1rem;border-bottom-left-radius:1rem}table td:last-child,.params td:last-child,table thead th:last-child,.params thead th:last-child,.props thead th:last-child{border-top-right-radius:1rem;border-bottom-right-radius:1rem}table th,.params th{position:sticky;top:0}.params .name,.props .name,.name code{font-family:"code";font-size:1rem}.params td,.params th,.props td,.props th,th,td{display:table-cell;margin:0;padding:1rem 2rem;text-align:left;vertical-align:top}.params thead tr,.props thead tr{font-weight:700}.params .params thead tr,.props .props thead tr{font-weight:700}.params td.description>p:first-child,.props td.description>p:first-child{margin-top:0;padding-top:0}.params td.description>p:last-child,.props td.description>p:last-child{margin-bottom:0;padding-bottom:0}dl.param-type{margin-bottom:1rem;padding-bottom:1rem}.param-type dt,.param-type dd{display:inline-block}.param-type dd{font-family:"code";font-size:1rem}code{border-radius:.3rem;font-family:"code";font-size:1rem;padding:.1rem .4rem}.mt-20{margin-top:1.5rem}.codepen-form{bottom:0;position:absolute;right:.6125rem}.body-wrapper{display:flex;flex-direction:column;height:100vh;position:relative}.sidebar-container{position:fixed;display:flex;padding:1rem;top:0;bottom:0;left:0;width:25rem;z-index:10}.sidebar{border-radius:1rem;flex:1;padding:1.5rem 0;overflow:hidden;display:flex;flex-direction:column}.sidebar-title{margin:0;padding:0 2rem;text-decoration:none;font-size:1.5rem;font-family:heading}.sidebar-title:hover{text-decoration:none}.sidebar-items-container{margin-top:5rem;overflow:auto;flex:1;position:relative}.sidebar-section-title{padding:.5rem 2rem;font-family:heading;font-size:1.25rem;border-radius:1rem}.with-arrow{align-items:center;cursor:pointer;display:flex}.with-arrow div{flex:1}.with-arrow svg{height:1rem;width:1rem;transition:transform .3s}.with-arrow[data-isopen=true] svg{transform:rotate(180deg)}.sidebar-section-children-container{border-radius:.5rem;overflow:hidden}.sidebar-section-children a{display:block;width:100%;padding:.25rem 2rem}.sidebar-section-children a{text-decoration:none}.with-arrow[data-isopen=false]+.sidebar-section-children-container{height:0;overflow:hidden}.with-arrow[data-isopen=true]+.sidebar-section-children-container{height:auto}.toc-container{position:fixed;top:0;right:4rem;bottom:0;width:16rem;z-index:10}.toc-content{padding-top:10rem;display:flex;flex-direction:column;height:100%}#eed4d2a0bfd64539bb9df78095dec881{margin:2rem 0;flex:1;overflow:auto}.toc-list{padding-left:1rem;list-style:none}.toc-link{display:block;white-space:nowrap;overflow:hidden;text-overflow:ellipsis;width:100%}.toc-link.is-active-link{font-family:heading}.has-anchor{position:relative}.link-anchor{padding:0 .5rem}.has-anchor .link-anchor{position:absolute;left:0;top:0;transform:translateX(-100%);text-decoration:none;visibility:hidden}.has-anchor:hover .link-anchor{visibility:visible}.navbar-container{position:fixed;z-index:10;top:0;left:25rem;right:25rem;height:7rem;padding-top:1rem;display:flex;justify-content:center}.navbar{display:flex;padding:1rem 4rem 1rem 2rem;flex:1;max-width:var(--outer-wrapper-max-width)}.navbar-left-items{display:flex;flex:1}.navbar-right-items{display:flex}.icon-button svg{height:1rem;width:1rem}.icon-button{background:0 0;position:relative;display:inline-flex;border:0;padding:.5rem;border-radius:50%;cursor:pointer;transition:background .3s}.navbar-right-item{display:flex;justify-content:center;align-items:center;margin:0 .25rem}.navbar-item{border-radius:.5rem;overflow:hidden}.navbar-item a{display:inline-block;padding:1rem 2rem;text-decoration:none;transition:.3s}.font-size-tooltip{display:flex;align-items:center;margin:0-.5rem}.font-size-tooltip .icon-button.disabled{pointer-events:none}.main-content{position:relative;flex:1;overflow:auto;display:flex;flex-direction:column;align-items:center;padding:7rem 25rem 0}.main-wrapper{width:100%;max-width:var(--outer-wrapper-max-width);padding:0 4rem 1rem}.p-h-n{padding:.4rem 1rem}.footer{width:100%;margin:5rem 0 0 0;border-radius:1rem;font-size:.875rem;display:flex;justify-content:center}.source-page+.footer{margin-top:3rem}.footer .wrapper{flex:1;padding:1rem 2rem;max-width:var(--outer-wrapper-max-width)}pre{position:relative}.hljs table td{background:0 0;padding:0 .6125rem;line-height:1.5;border-radius:0}.hljs .hljs-ln-numbers{width:2rem;white-space:nowrap;padding-left:1.5rem}.hljs-ln-line.hljs-ln-numbers::before{content:attr(data-line-number)}.pre-div{position:relative;border-radius:1rem;overflow:hidden;margin:2rem 0}.pre-top-bar-container{align-items:center;display:flex;justify-content:space-between;left:0;padding:.3125rem 1.5rem;position:absolute;right:0;top:0}.code-copy-icon-container{align-items:center;border-radius:50%;cursor:pointer;display:flex;height:1.875rem;justify-content:center;transition:.3s;width:1.875rem}.code-copy-icon-container>div{margin-top:.25rem;position:relative}.sm-icon{height:1rem;width:1rem}.code-lang-name{font-family:"body";font-size:.75rem}.tooltip{border-radius:.3125rem;opacity:0;padding:.1875rem .5rem;position:absolute;right:2rem;top:.3125rem;transform:scale(0);transition:.3s}.show-tooltip{opacity:1;transform:scale(1)}.allow-overflow{overflow:auto}.bold{font-family:heading}.search-container{position:fixed;top:0;bottom:0;right:0;left:0;justify-content:center;z-index:50;align-items:flex-start}.search-container .wrapper{width:100%;max-width:60rem;padding:4rem 2rem 2rem;border-radius:1rem;margin:3rem 25rem;position:relative}.search-close-button{position:absolute;top:1rem;right:1rem}.search-result-c-text{display:flex;justify-content:center;user-select:none}.search-result-c{min-height:20rem;max-height:40rem;overflow:auto;padding:2rem 0}.search-box-c{width:100%;position:relative;display:flex;align-items:center}.search-box-c svg{height:1.5rem;width:1.5rem;position:absolute;left:1.5rem}.search-input{border:0;border-radius:1rem;width:100%;flex:1;padding:1rem 2rem 1rem 4rem;font-family:body;font-size:1.25rem}.search-result-item{display:block;text-decoration:none;padding:1rem;border-radius:1rem;margin:1rem 0}.search-result-item:hover{text-decoration:none}.search-result-item:active{text-decoration:none}.search-result-item-title{font-family:heading;font-size:1.5rem;margin:0}.search-result-item-p{font-size:.875rem;margin:0}.mobile-menu-icon-container{display:none;position:fixed;bottom:1.5rem;right:2rem;z-index:30}.mobile-menu-icon-container .icon-button svg{height:2rem;width:2rem}.mobile-sidebar-container{position:fixed;top:0;right:0;left:0;bottom:0;padding:1rem;z-index:25;display:none}.mobile-sidebar-container.show{display:block}.mobile-sidebar-wrapper{border-radius:1rem;height:100%;width:100%;display:flex;flex-direction:column;padding-top:2rem}.mobile-nav-links{display:flex;flex-wrap:wrap;padding-top:2rem}.mobile-sidebar-items-c{flex:1;overflow:auto}.mobile-navbar-actions{display:flex;padding:1rem}.rel{position:relative}.icon-button.codepen-button svg{height:1.5rem;width:1.5rem}.table-div{width:100%;overflow:auto}.tag-default{overflow:auto}::-webkit-scrollbar{width:.3125rem;height:.3125rem}::-webkit-scrollbar-thumb,::-webkit-scrollbar-track{border-radius:1rem}@media screen and (max-width:100em){.toc-container{display:none}.main-content{padding:7rem 0 0 25rem}.search-container .wrapper{margin-right:1rem}.navbar-container{right:1rem}}@media screen and (min-width:65em){.mobile-sidebar-container.show{display:none}}@media screen and (max-width:65em){h1{font-size:3rem}h2{font-size:2rem}h3{font-size:1.875}h4,h5,h6{font-size:1rem}.main-wrapper{padding:0 1rem 1rem}.search-result-c{max-height:25rem}.mobile-menu-icon-container{display:block}.sidebar-container{display:none}.search-container .wrapper{margin-left:1rem}.main-content{padding-left:0;padding-top:1rem}.navbar-container{display:none}.source-page+.footer,.footer{margin-top:2rem}.has-anchor:hover .link-anchor{visibility:hidden}}::selection{background:#ffce76;color:#222}body{background-color:#1a1a1a;color:#fff}a,a:active{color:#0bf}hr{color:#222}h1,h2,h3,h4,h5,h6{color:#fff}.sidebar{background-color:#222;color:#999}.sidebar-title{color:#999}.sidebar-section-title{color:#999}.sidebar-section-title:hover{background:#252525}.with-arrow{fill:#999}.sidebar-section-children-container{background:#292929}.sidebar-section-children a:hover{background:#2c2c2c}.sidebar-section-children a{color:#fff}.navbar-container{background:#1a1a1a}.icon-button svg,.navbar-item a{color:#999;fill:#999}.font-size-tooltip .icon-button svg{fill:#fff}.font-size-tooltip .icon-button.disabled{background:#999}.icon-button:hover{background:#333}.icon-button:active{background:#444}.navbar-item a:active{color:#aaa;background-color:#222}.navbar-item:hover{background:#202020}.footer{background:#222;color:#999}.footer a{color:#999}.toc-link{color:#777;transition:color .3s;font-size:.875rem}.toc-link.is-active-link{color:#fff}.has-anchor .link-anchor{color:#555}.has-anchor .link-anchor:hover{color:#888}tt,code,kbd,samp{background:#333}.signature-attributes{color:#aaa}.ancestors{color:#999}.ancestors a{color:#999!important}.important{color:#c51313}.type-signature{color:#00918e}.name,.name a{color:#f7f7f7}.details{background:#222;color:#fff}.prettyprint{background:#222}.member-item-container strong,.method-member-container strong{color:#fff}.pre-top-bar-container{background:#292929}.prettyprint.source,.prettyprint code{background-color:#222;color:#c9d1d9}.pre-div{background-color:#222}.hljs .hljs-ln-numbers{color:#777}.hljs .selected{background:#444}.hljs .selected .hljs-ln-numbers{color:#eee}table .name,.params .name,.props .name,.name code{color:#fff}table td,.params td{background-color:#292929}table thead th,.params thead th,.props thead th{background-color:#222;color:#fff}table .params thead tr,.params .params thead tr,.props .props thead tr{background-color:#222;color:#fff}.disabled{color:#aaa}.code-lang-name{color:#ff8a00}.tooltip{background:#ffce76;color:#222}.hljs-comment{color:#8b949e}.hljs-doctag,.hljs-keyword,.hljs-template-tag,.hljs-variable.language_{color:#ff7b72}.hljs-template-variable,.hljs-type{color:#30ac7c}.hljs-meta,.hljs-string,.hljs-regexp{color:#a5d6ff}.hljs-title.class_,.hljs-title{color:#ffa657}.hljs-title.class_.inherited__,.hljs-title.function_{color:#d2a8ff}.hljs-attr,.hljs-attribute,.hljs-literal,.hljs-meta,.hljs-number,.hljs-operator,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-id,.hljs-variable{color:#79c0ff}.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#a5d6ff}.hljs-built_in,.hljs-symbol{color:#ffa657}.hljs-code,.hljs-comment,.hljs-formula{color:#8b949e}.hljs-name,.hljs-quote,.hljs-selector-pseudo,.hljs-selector-tag{color:#7ee787}.hljs-subst{color:#c9d1d9}.hljs-section{color:#1f6feb;font-weight:700}.hljs-bullet{color:#f2cc60}.hljs-emphasis{color:#c9d1d9;font-style:italic}.hljs-strong{color:#c9d1d9;font-weight:700}blockquote{background:#222;color:#fff}.search-container{background:rgba(255,255,255,.1)}.icon-button.search-close-button svg{fill:#a00}.search-container .wrapper{background:#222}.search-result-c{color:#666}.search-box-c{fill:#333}.search-input{background:#333;color:#fff}.search-box-c svg{fill:#fff}.search-result-item{background:#333}.search-result-item:hover{background:#444}.search-result-item:active{background:#555}.search-result-item-title{color:#fff}.search-result-item-p{color:#aaa}.mobile-menu-icon-container .icon-button{background:#333}.mobile-sidebar-container{background:#1a1a1a}.mobile-sidebar-wrapper{background:#222}::-webkit-scrollbar-track{background:#333}::-webkit-scrollbar-thumb{background:#555;outline:.06125rem solid #555}.light ::selection{background:#ffce76;color:#1d1919}body.light{background-color:#fff;color:#111}.light a,.light a:active{color:#007bff}.light hr{color:#f7f7f7}.light h1,.light h2,.light h3,.light h4,.light h5,.light h6{color:#111}.light .sidebar{background-color:#f7f7f7;color:#222}.light .sidebar-title{color:#222}.light .sidebar-section-title{color:#222}.light .sidebar-section-title:hover{background:#eee}.light .with-arrow{fill:#111}.light .sidebar-section-children-container{background:#eee}.light .sidebar-section-children a:hover{background:#e0e0e0}.light .sidebar-section-children a{color:#111}.light .navbar-container{background:#fff}.light .icon-button svg,.light .navbar-item a{color:#222;fill:#222}.light .tippy-box{background:#eee;color:#111}.light .tippy-arrow{color:#f1f1f1}.light .font-size-tooltip .icon-button svg{fill:#111}.light .font-size-tooltip .icon-button.disabled svg{fill:#999}.light .icon-button:hover{background:#ddd}.light .icon-button:active{background:#ccc}.light .navbar-item a:active{color:#333;background-color:#eee}.light .navbar-item:hover{background:#f7f7f7}.light .footer{background:#f7f7f7;color:#111}.light .footer a{color:#111}.light .toc-link{color:#999;transition:color .3s;font-size:.875rem}.light .toc-link.is-active-link{color:#111}.light .has-anchor .link-anchor{color:#ddd}.light .has-anchor .link-anchor:hover{color:#ccc}.light .signature-attributes{color:#aaa}.light .ancestors{color:#999}.light .ancestors a{color:#999!important}.light .important{color:#ee1313}.light .type-signature{color:#00918e}.light .name,.light .name a{color:#293a80}.light .details{background:#f9f9f9;color:#101010}.light .member-item-container strong,.light .method-member-container strong{color:#000}.light .prettyprint{background:#f7f7f7}.light .pre-div{background:#f7f7f7}.light .hljs .hljs-ln-numbers{color:#aaa}.light .hljs .selected{background:#ccc}.light table.hljs-ln td{background:0 0}.light .hljs .selected .hljs-ln-numbers{color:#444}.light .pre-top-bar-container{background-color:#eee}.light .prettyprint code{background-color:#f7f7f7}.light table .name,.light .params .name,.light .props .name,.light .name code{color:#4d4e53}.light table td,.light .params td{background:#f7f7f7}.light table thead th,.light .params thead th,.light .props thead th{background-color:#eee;color:#111}.light table .params thead tr,.light .params .params thead tr,.light .props .props thead tr{background-color:#eee;color:#111}.light .disabled{color:#454545}.light .code-lang-name{color:red}.light .tooltip{background:#ffce76;color:#000}.light .hljs-comment,.light .hljs-quote{color:#a0a1a7}.light .hljs-doctag,.light .hljs-keyword,.light .hljs-formula{color:#a626a4}.light .hljs-section,.light .hljs-name,.light .hljs-selector-tag,.light .hljs-deletion,.light .hljs-subst{color:#e45649}.light .hljs-literal{color:#0184bb}.light .hljs-string,.light .hljs-regexp,.light .hljs-addition,.light .hljs-attribute,.light .hljs-meta .hljs-string{color:#50a14f}.light .hljs-attr,.light .hljs-variable,.light .hljs-template-variable,.light .hljs-type,.light .hljs-selector-class,.light .hljs-selector-attr,.light .hljs-selector-pseudo,.light .hljs-number{color:#986801}.light .hljs-symbol,.light .hljs-bullet,.light .hljs-link,.light .hljs-meta,.light .hljs-selector-id,.light .hljs-title{color:#4078f2}.light .hljs-built_in,.light .hljs-title.class_,.light .hljs-class .hljs-title{color:#c18401}.light .hljs-emphasis{font-style:italic}.light .hljs-strong{font-weight:700}.light .hljs-link{text-decoration:underline}.light blockquote{background:#eee;color:#111}.light code{background:#ddd;color:#000}.light .search-container{background:rgba(0,0,0,.1)}.light .search-close-button svg{fill:red}.light .search-container .wrapper{background:#eee}.light .search-result-c{color:#aaa}.light .search-box-c svg{fill:#333}.light .search-input{background:#f7f7f7;color:#111}.light .search-result-item{background:#f7f7f7}.light .search-result-item:hover{background:#e9e9e9}.light .search-result-item:active{background:#f7f7f7}.light .search-result-item-title{color:#111}.light .search-result-item-p{color:#aaa}.light .mobile-menu-icon-container .icon-button{background:#e5e5e5}.light .mobile-sidebar-container{background:#fff}.light .mobile-sidebar-wrapper{background:#f7f7f7}.light ::-webkit-scrollbar-track{background:#ddd}.light ::-webkit-scrollbar-thumb{background:#aaa;outline:.06125rem solid #aaa}
@@ -1,13 +0,0 @@
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: Authentication</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">Home</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><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#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</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#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#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/offsides#README.md" 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>Authentication</h2></header><article><p>There are two supported methods of authenticating a Sidechat.js API client. We recommend the automatic method, but you may choose to use the manual method if your project involves multiple instances of <code>SidechatAPIClient</code>.</p><p>Go ahead and import <code>SidechatAPIClient</code> from the module:</p><pre class="prettyprint source lang-javascript"><code>import { SidechatAPIClient } from &quot;sidechat.js&quot;;
4
- </code></pre><h3 id="automatic-method">Automatic method</h3><p>For existing users, this is trivial. First, send the user a verification code to their phone number. Make sure the passed phone number is in a 10-digit format with no dashes, spaces, or parentheses:</p><pre class="prettyprint source lang-javascript"><code>const phoneNumber = /* User's phone number */;
5
- await API.loginViaSMS(phoneNumber);
6
- </code></pre><p>Then once the user has inputted the 6-digit code into your application, verify it with the API:</p><pre class="prettyprint source lang-javascript"><code>const code = /* SMS verification code */;
7
- await API.verifySMSCode(phoneNumber, code);
8
- </code></pre><p>If the user already exists, calling those two functions will set the user token and all requests from here on out using this instance of the API client will be automatically authenticated.</p><p>If the user has not used Sidechat before, the <code>verifySMSCode</code> will return a <code>registrationID</code>, which you should store and then use to call the <code>setAge</code> function:</p><pre class="prettyprint source lang-javascript"><code>// Here &quot;res&quot; refers to the result of verifySMSCode()
9
- const { registration_id } = res;
10
- await API.setAge(18, registration_id);
11
- </code></pre><p>Now the user should be logged in properly and future requests will be automatically authenticated. You may still need to <a href="tutorial-Email%20Registration.html">add an email address</a> for most functionality.</p><h3 id="manual-method">Manual method</h3><p>You can pass a user token directly to the constructor initialization:</p><pre class="prettyprint source lang-javascript"><code>const token = /* User bearer token as a string */;
12
- const API = new SidechatAPIClient(token);
13
- </code></pre><p>All requests from here on out using this instance of the API client will automatically use the token passed to the constructor.</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">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" 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><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#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</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#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#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>
@@ -1,6 +0,0 @@
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">Home</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><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#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</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#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#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/offsides#README.md" 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">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" 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><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#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</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#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#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>