sidechat.js 2.3.7 → 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 +38 -6
  6. package/dist/index.mjs +38 -6
  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 +33 -0
  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
package/docs/sidechat.js/2.0.4/classes_SidechatAPIClient.js.html DELETED
@@ -1,425 +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>Source: classes/SidechatAPIClient.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">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#SidechatAsset">SidechatAsset</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#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#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 id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">classes_SidechatAPIClient.js</h1></header><article><pre class="prettyprint source lang-js"><code>import "../types/SidechatTypes.js";
4
- import SidechatAPIError from "../classes/SidechatAPIError.js";
5
-
6
- /**
7
- * API client class for making requests to Sidechat's private API. You'll need to [authenticate]{@tutorial Authentication} before using most of the methods.
8
- * @class
9
- * @since 2.0.0-alpha.0
10
- */
11
- class SidechatAPIClient {
12
- /**
13
- * User bearer token
14
- * @type {SidechatAuthToken}
15
- * */
16
- userToken;
17
- /**
18
- * Default headers for every API request
19
- * @type {Object}
20
- * @static
21
- */
22
- defaultHeaders = {
23
- Accept: "application/json",
24
- "Content-Type": "application/json",
25
- };
26
-
27
- /**
28
- * Create a new instance of the API client
29
- * @param {SidechatAuthToken} [token] - user bearer token
30
- */
31
- constructor(token = "") {
32
- if (token) {
33
- this.userToken = token;
34
- }
35
- }
36
-
37
- /**
38
- * Manually set the currently signed in user's token. Generally try to avoid this and instead either pass a token to the constructor or login automatically through the auth functions
39
- * @method
40
- * @param {SidechatAuthToken} token - user bearer token
41
- */
42
- setToken = (token) => {
43
- this.userToken = token;
44
- };
45
-
46
- /**
47
- * Initiate the login process with a phone number. Should be followed up with verifySMSCode().
48
- * @method
49
- * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
50
- */
51
- loginViaSMS = async (phoneNumber) => {
52
- try {
53
- const res = await fetch(`https://api.sidechat.lol/v1/login_register`, {
54
- method: "POST",
55
- headers: this.defaultHeaders,
56
- body: JSON.stringify({
57
- phone_number: `+1${phoneNumber}`,
58
- version: 3,
59
- }),
60
- });
61
- const json = await res.json();
62
- return json;
63
- } catch (err) {
64
- console.error(err);
65
- throw new SidechatAPIError("Failed to request SMS verification.");
66
- }
67
- };
68
-
69
- /**
70
- * Verify the code sent via SMS with loginViaSMS().
71
- * @method
72
- * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
73
- * @param {String} code - the verification code
74
- */
75
- verifySMSCode = async (phoneNumber, code) => {
76
- try {
77
- const res = await fetch(
78
- `https://api.sidechat.lol/v1/verify_phone_number`,
79
- {
80
- method: "POST",
81
- headers: this.defaultHeaders,
82
- body: JSON.stringify({
83
- phone_number: `+1${phoneNumber}`,
84
- code: code.toUpperCase(),
85
- }),
86
- }
87
- );
88
- const json = await res.json();
89
- if (json?.logged_in_user?.token) {
90
- this.userToken = json.logged_in_user.token;
91
- }
92
- return json;
93
- } catch (err) {
94
- console.error(err);
95
- throw new SidechatAPIError("Failed verify this code.");
96
- }
97
- };
98
-
99
- /**
100
- * Set the user's age
101
- * @method
102
- * @param {Number} age - user's age in years
103
- * @param {String} registrationID - the registration ID generated by verifySMSCode()
104
- */
105
- setAge = async (age, registrationID) => {
106
- if (age &lt; 13) {
107
- throw new SidechatAPIError("You're too young to use Offsides.");
108
- }
109
- try {
110
- const res = await fetch(
111
- `https://api.sidechat.lol/v1/complete_registration`,
112
- {
113
- method: "POST",
114
- headers: this.defaultHeaders,
115
- body: JSON.stringify({
116
- age: Number(age),
117
- registration_id: registrationID,
118
- }),
119
- }
120
- );
121
- const json = await res.json();
122
- if (json.token) {
123
- this.userToken = json.token;
124
- }
125
- return json;
126
- } catch (err) {
127
- console.error(err);
128
- throw new SidechatAPIError("Failed verify this code.");
129
- }
130
- };
131
-
132
- /**
133
- * Initiate the email setup process. Should be followed up with checkEmailVerification().
134
- * @method
135
- * @param {String} email - school email address to send verification code to
136
- * @tutorial Email Registration
137
- */
138
- registerEmail = async (email) => {
139
- if (!this.userToken) {
140
- throw new SidechatAPIError("User is not authenticated.");
141
- }
142
- try {
143
- const res = await fetch(
144
- `https://api.sidechat.lol/v2/users/register_email`,
145
- {
146
- method: "POST",
147
- headers: {
148
- ...this.defaultHeaders,
149
- Authorization: `Bearer ${this.userToken}`,
150
- },
151
- body: JSON.stringify({
152
- email: email,
153
- }),
154
- }
155
- );
156
- const json = await res.json();
157
- if (json.message) {
158
- throw new SidechatAPIError(json.message);
159
- }
160
- return json;
161
- } catch (err) {
162
- console.error(error);
163
- throw new SidechatAPIError("Failed to request email verification.");
164
- }
165
- };
166
-
167
- /**
168
- * Check is the user's email is verified.
169
- * @method
170
- */
171
- checkEmailVerification = async () => {
172
- if (!this.userToken) {
173
- throw new SidechatAPIError("User is not authenticated.");
174
- }
175
- try {
176
- const res = await fetch(
177
- `https://api.sidechat.lol/v1/users/check_email_verified`,
178
- {
179
- method: "GET",
180
- headers: {
181
- ...this.defaultHeaders,
182
- Authorization: `Bearer ${this.userToken}`,
183
- },
184
- }
185
- );
186
- const json = await res.json();
187
- if (json.verified_email_updates_response) {
188
- return json.verified_email_updates_response;
189
- } else {
190
- throw new SidechatAPIError(json?.message || "Email is not verified.");
191
- }
192
- } catch (err) {
193
- console.error(error);
194
- throw new SidechatAPIError("Email is not verified.");
195
- }
196
- };
197
-
198
- /**
199
- * Set the device ID of the current user
200
- * @method
201
- * @param {String} deviceId - the device ID to set
202
- */
203
- setDeviceID = async (deviceID) => {
204
- if (!this.userToken) {
205
- throw new SidechatAPIError("User is not authenticated.");
206
- }
207
- try {
208
- const res = await fetch(
209
- `https://api.sidechat.lol/v1/register_device_token`,
210
- {
211
- method: "POST",
212
- headers: {
213
- ...this.defaultHeaders,
214
- Authorization: `Bearer ${this.userToken}`,
215
- },
216
- body: JSON.stringify({
217
- build_type: "release",
218
- bundle_id: "com.flowerave.sidechat",
219
- device_token: deviceID,
220
- }),
221
- }
222
- );
223
- const json = await res.json();
224
- await AsyncStorage.setItem("deviceID", deviceID);
225
- return json;
226
- } catch (err) {
227
- console.error(err);
228
- throw new SidechatAPIError("Failed verify this code.");
229
- }
230
- };
231
-
232
- /**
233
- * Get updated status for user and group
234
- * @method
235
- * @param {String} [groupID] - ID of a specific group to retrieve info from
236
- */
237
- getUserAndGroup = async (groupID = "") => {
238
- if (!this.userToken) {
239
- throw new SidechatAPIError("User is not authenticated.");
240
- }
241
- try {
242
- const res = await fetch(
243
- `https://api.sidechat.lol/v1/updates?group_id=${groupID}`,
244
- {
245
- method: "GET",
246
- headers: {
247
- ...this.defaultHeaders,
248
- Authorization: `Bearer ${this.userToken}`,
249
- },
250
- }
251
- );
252
- const json = await res.json();
253
- return json;
254
- } catch (err) {
255
- console.error(err);
256
- throw new SidechatAPIError(`Failed to get posts from group.`);
257
- }
258
- };
259
-
260
- /**
261
- * Fetches posts from the specified category in a group
262
- * @method
263
- * @param {String} groupID - group ID
264
- * @param {"hot"|"recent"|"top"} category - category to filter posts
265
- * @param {SidechatCursorString} [cursor] - cursor string
266
- * @returns {SidechatPostsAndCursor} List of posts and cursor
267
- */
268
- getGroupPosts = async (groupID, category = "hot", cursor) => {
269
- if (!this.userToken) {
270
- throw new SidechatAPIError("User is not authenticated.");
271
- }
272
- try {
273
- const res = await fetch(
274
- `https://api.sidechat.lol/v1/posts?group_id=${groupID}&amp;type=${category}${
275
- cursor ? "&amp;cursor=" + cursor : ""
276
- }`,
277
- {
278
- method: "GET",
279
- headers: {
280
- ...this.defaultHeaders,
281
- Authorization: `Bearer ${this.userToken}`,
282
- },
283
- }
284
- );
285
- const json = await res.json();
286
- return json;
287
- } catch (err) {
288
- console.error(err);
289
- throw new SidechatAPIError(`Failed to get posts from group.`);
290
- }
291
- };
292
-
293
- /**
294
- * Upvote or downvote, or unvote a post
295
- * @method
296
- * @param {String} postID - post ID to vote on
297
- * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote
298
- */
299
- setVote = async (postID, action) => {
300
- if (!this.userToken) {
301
- throw new SidechatAPIError("User is not authenticated.");
302
- }
303
- try {
304
- const res = await fetch(`https://api.sidechat.lol/v1/posts/set_vote`, {
305
- method: "POST",
306
- headers: {
307
- ...this.defaultHeaders,
308
- Authorization: `Bearer ${this.userToken}`,
309
- },
310
- body: JSON.stringify({
311
- post_id: postID,
312
- vote_status: action,
313
- }),
314
- });
315
- const json = await res.json();
316
- return json;
317
- } catch (err) {
318
- console.error(err);
319
- throw new SidechatAPIError(`Failed to change the vote on post.`);
320
- }
321
- };
322
-
323
- /**
324
- * Get all the commments on a post
325
- * @method
326
- * @param {String} postID - post ID to get comments for
327
- * @returns {SidechatPostOrComment[]} list of comments
328
- */
329
- getPostComments = async (postID) => {
330
- if (!this.userToken) {
331
- throw new SidechatAPIError("User is not authenticated.");
332
- }
333
- try {
334
- const res = await fetch(
335
- `https://api.sidechat.lol/v1/posts/comments/?post_id=${postID}`,
336
- {
337
- method: "GET",
338
- headers: {
339
- ...this.defaultHeaders,
340
- Authorization: `Bearer ${this.userToken}`,
341
- },
342
- }
343
- );
344
- const json = await res.json();
345
- // Function to preprocess the comments and organize them into a nested structure
346
- function preprocessComments(apiComments) {
347
- // Map to store comments by their IDs for efficient lookup
348
- const commentMap = new Map();
349
- // List to store top-level comments
350
- const topLevelComments = [];
351
-
352
- // Iterate through the API comments
353
- apiComments.forEach((comment) => {
354
- // Store the comment in the map with its ID as the key
355
- commentMap.set(comment.id, comment);
356
- // Get the parent comment using the reply_post_id
357
- const parentComment = commentMap.get(comment.reply_post_id);
358
- // Check if the comment is a top-level comment
359
- if (
360
- !parentComment ||
361
- comment.reply_post_id === comment.parent_post_id
362
- ) {
363
- // If it's a top-level comment, push it to the topLevelComments array
364
- topLevelComments.push(comment);
365
- } else {
366
- // If it's a reply, add it to the parent comment's replies array
367
- if (!parentComment.replies) parentComment.replies = [];
368
- parentComment.replies.push(comment);
369
- }
370
- });
371
-
372
- // Flatten the nested structure and return a single list of comments
373
- return flattenComments(topLevelComments);
374
- }
375
-
376
- // Function to flatten nested comments into a single list
377
- function flattenComments(comments) {
378
- // Use reduce to flatten the nested comments array into a single list
379
- return comments.reduce((flatComments, comment) => {
380
- // Push the current comment to the flatComments array
381
- flatComments.push(comment);
382
- // If the current comment has replies, recursively flatten them and push to the flatComments array
383
- if (comment.replies)
384
- flatComments.push(...flattenComments(comment.replies));
385
- // Return the flatComments array
386
- return flatComments;
387
- }, []);
388
- }
389
-
390
- const sortedComments = preprocessComments(json.posts);
391
- return sortedComments;
392
- } catch (err) {
393
- console.error(err);
394
- throw new SidechatAPIError(`Failed to get comments on post.`);
395
- }
396
- };
397
-
398
- /**
399
- * Gets groups to be displayed on the "Explore Groups" page
400
- * @method
401
- * @returns {SidechatGroup[]}
402
- */
403
- getAvailableGroups = async () => {
404
- if (!this.userToken) {
405
- throw new SidechatAPIError("User is not authenticated.");
406
- }
407
- try {
408
- const res = await fetch(`https://api.sidechat.lol/v1/groups/explore`, {
409
- method: "GET",
410
- headers: {
411
- ...this.defaultHeaders,
412
- Authorization: `Bearer ${this.userToken}`,
413
- },
414
- });
415
- const json = await res.json();
416
- return await json.groups;
417
- } catch (err) {
418
- console.error(err);
419
- throw new SidechatAPIError(`Failed to get groups from explore.`);
420
- }
421
- };
422
- }
423
-
424
- export default SidechatAPIClient;
425
- </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">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#SidechatAsset">SidechatAsset</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#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#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.0.4/data/search.json DELETED
@@ -1 +0,0 @@
1
- {"list":[{"title":"SidechatAPIClient","link":"<a href=\"SidechatAPIClient.html\">SidechatAPIClient</a>","description":"<p>Create a new instance of the API client</p>"},{"title":"SidechatAPIClient#checkEmailVerification","link":"<a href=\"SidechatAPIClient.html#checkEmailVerification\">checkEmailVerification</a>","description":"<p>Check is the user's email is verified.</p>"},{"title":"SidechatAPIClient#defaultHeaders","link":"<a href=\"SidechatAPIClient.html#defaultHeaders\">defaultHeaders</a>","description":"<p>Default headers for every API request</p>"},{"title":"SidechatAPIClient#getAvailableGroups","link":"<a href=\"SidechatAPIClient.html#getAvailableGroups\">getAvailableGroups</a>","description":"<p>Gets groups to be displayed on the &quot;Explore Groups&quot; page</p>"},{"title":"SidechatAPIClient#getGroupPosts","link":"<a href=\"SidechatAPIClient.html#getGroupPosts\">getGroupPosts</a>","description":"<p>Fetches posts from the specified category in a group</p>"},{"title":"SidechatAPIClient#getPostComments","link":"<a href=\"SidechatAPIClient.html#getPostComments\">getPostComments</a>","description":"<p>Get all the commments on a post</p>"},{"title":"SidechatAPIClient#getUserAndGroup","link":"<a href=\"SidechatAPIClient.html#getUserAndGroup\">getUserAndGroup</a>","description":"<p>Get updated status for user and group</p>"},{"title":"SidechatAPIClient#loginViaSMS","link":"<a href=\"SidechatAPIClient.html#loginViaSMS\">loginViaSMS</a>","description":"<p>Initiate the login process with a phone number. Should be followed up with verifySMSCode().</p>"},{"title":"SidechatAPIClient#registerEmail","link":"<a href=\"SidechatAPIClient.html#registerEmail\">registerEmail</a>","description":"<p>Initiate the email setup process. Should be followed up with checkEmailVerification().</p>"},{"title":"SidechatAPIClient#setAge","link":"<a href=\"SidechatAPIClient.html#setAge\">setAge</a>","description":"<p>Set the user's age</p>"},{"title":"SidechatAPIClient#setDeviceID","link":"<a href=\"SidechatAPIClient.html#setDeviceID\">setDeviceID</a>","description":"<p>Set the device ID of the current user</p>"},{"title":"SidechatAPIClient#setToken","link":"<a href=\"SidechatAPIClient.html#setToken\">setToken</a>","description":"<p>Manually set the currently signed in user's token. Generally try to avoid this and instead either pass a token to the constructor or login automatically through the auth functions</p>"},{"title":"SidechatAPIClient#setVote","link":"<a href=\"SidechatAPIClient.html#setVote\">setVote</a>","description":"<p>Upvote or downvote, or unvote a post</p>"},{"title":"SidechatAPIClient#userToken","link":"<a href=\"SidechatAPIClient.html#userToken\">userToken</a>","description":"<p>User bearer token</p>"},{"title":"SidechatAPIClient#verifySMSCode","link":"<a href=\"SidechatAPIClient.html#verifySMSCode\">verifySMSCode</a>","description":"<p>Verify the code sent via SMS with loginViaSMS().</p>"},{"title":"SidechatAPIError","link":"<a href=\"SidechatAPIError.html\">SidechatAPIError</a>"},{"title":"SidechatAsset","link":"<a href=\"global.html#SidechatAsset\">SidechatAsset</a>","description":"<p>An asset object, containing information about an image within a post or comment</p>"},{"title":"SidechatAuthToken","link":"<a href=\"global.html#SidechatAuthToken\">SidechatAuthToken</a>","description":"<p>A user's bearer authentication token needed for most requests</p>"},{"title":"SidechatCursorString","link":"<a href=\"global.html#SidechatCursorString\">SidechatCursorString</a>","description":"<p>A cursor for paginating through post lists</p>"},{"title":"SidechatGroup","link":"<a href=\"global.html#SidechatGroup\">SidechatGroup</a>","description":"<p>A group object, containing metadata about a group as well as its join conditions and states</p>"},{"title":"SidechatIdentity","link":"<a href=\"global.html#SidechatIdentity\">SidechatIdentity</a>","description":"<p>A user's identity information</p>"},{"title":"SidechatPostOrComment","link":"<a href=\"global.html#SidechatPostOrComment\">SidechatPostOrComment</a>","description":"<p>A user-created post or comment, depending on the &quot;type&quot; prop</p>"},{"title":"SidechatPostsAndCursor","link":"<a href=\"global.html#SidechatPostsAndCursor\">SidechatPostsAndCursor</a>","description":"<p>A list of posts and the associated cursor</p>"},{"title":"SidechatPrivateAssetURL","link":"<a href=\"global.html#SidechatPrivateAssetURL\">SidechatPrivateAssetURL</a>","description":"<p>An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header</p>"},{"title":"SidechatVoteString","link":"<a href=\"global.html#SidechatVoteString\">SidechatVoteString</a>","description":"<p>A vote on a comment or post</p>"}]}
package/docs/sidechat.js/2.0.4/global.html DELETED
@@ -1,3 +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>Global</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#SidechatAsset">SidechatAsset</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#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#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><article><div class="container-overview"></div><h2 id="type-definitions" class="subsection-title has-anchor">Type Definitions</h2><h3 class="name has-anchor" id="SidechatAsset">SidechatAsset</h3><div class="description"><p>An asset object, containing information about an image within a post or comment</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>alphanumeric ID of asset</p></td></tr><tr><td class="name"><code>type</code></td><td class="type"><span class="param-type">"image"</span></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>content_type</code></td><td class="type"><span class="param-type">"jpeg"</span> |<wbr> <span class="param-type">"png"</span> |<wbr> <span class="param-type">"gif"</span></td><td class="description last"><p>file type of asset</p></td></tr><tr><td class="name"><code>width</code></td><td class="type"><span class="param-type">Number</span></td><td class="description last"><p>the width of asset</p></td></tr><tr><td class="name"><code>height</code></td><td class="type"><span class="param-type">Number</span></td><td class="description last"><p>the height of asset</p></td></tr><tr><td class="name"><code>url</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></span></td><td class="description last"><p>URL string of asset's location</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line48">line 48</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatAuthToken">SidechatAuthToken</h3><div class="description"><p>A user's bearer authentication token needed for most requests</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">String</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line81">line 81</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatCursorString">SidechatCursorString</h3><div class="description"><p>A cursor for paginating through post lists</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">String</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line71">line 71</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatGroup">SidechatGroup</h3><div class="description"><p>A group object, containing metadata about a group as well as its join conditions and states</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>alphanumeric ID of group</p></td></tr><tr><td class="name"><code>name</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>human-readable name of group</p></td></tr><tr><td class="name"><code>analytics_name</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>name to file group under</p></td></tr><tr><td class="name"><code>membership_type</code></td><td class="type"><span class="param-type">"non_member"</span> |<wbr> <span class="param-type">"member"</span></td><td class="attributes"></td><td class="description last"><p>whether or not current user is a member of group</p></td></tr><tr><td class="name"><code>color</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>group's theme color as hex code (e.g., #FFFFFF)</p></td></tr><tr><td class="name"><code>group_join_type</code></td><td class="type"><span class="param-type">"open"</span> |<wbr> <span class="param-type">"closed"</span> |<wbr> <span class="param-type">"email_domain"</span></td><td class="attributes"></td><td class="description last"><p>basis on which group accepts new members</p></td></tr><tr><td class="name"><code>group_visibility</code></td><td class="type"><span class="param-type">"private"</span> |<wbr> <span class="param-type">"public_to_all"</span> |<wbr> <span class="param-type">"public_to_schools"</span></td><td class="attributes"></td><td class="description last"><p>group's visibility setting</p></td></tr><tr><td class="name"><code>asset_library_visibility</code></td><td class="type"><span class="param-type">"show"</span> |<wbr> <span class="param-type">"hide"</span></td><td class="attributes"></td><td class="description last"><p>whether or not group's asset library is visible</p></td></tr><tr><td class="name"><code>roles</code></td><td class="type"><span class="param-type">Array</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>description</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>description of group</p></td></tr><tr><td class="name"><code>icon_url</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>image URL for group icon</p></td></tr><tr><td class="name"><code>member_count</code></td><td class="type"><span class="param-type">Number</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>number of users in group</p></td></tr><tr><td class="name"><code>should_show_leaderboard</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>undocumented</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line30">line 30</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatIdentity">SidechatIdentity</h3><div class="description"><p>A user's identity information</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>name</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>representation of user's name (varies across app)</p></td></tr><tr><td class="name"><code>posted_with_username</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="description last"><p>undocumented</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line59">line 59</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatPostOrComment">SidechatPostOrComment</h3><div class="description"><p>A user-created post or comment, depending on the &quot;type&quot; prop</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>type</code></td><td class="type"><span class="param-type">"post"</span> |<wbr> <span class="param-type">"comment"</span></td><td class="attributes"></td><td class="description last"><p>whether this object represents a post or a comment on a post</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>alphanumeric ID of post or comment</p></td></tr><tr><td class="name"><code>authored_by_user</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="attributes"></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>alias</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>post creator's name in-app</p></td></tr><tr><td class="name"><code>group_id</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>alphanumeric ID of group</p></td></tr><tr><td class="name"><code>group</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatGroup">SidechatGroup</a></span></td><td class="attributes"></td><td class="description last"><p>group in which post or comment was created</p></td></tr><tr><td class="name"><code>text</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>text content of post or comment</p></td></tr><tr><td class="name"><code>created_at</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes"></td><td class="description last"><p>date string of post or comment creation time</p></td></tr><tr><td class="name"><code>vote_total</code></td><td class="type"><span class="param-type">Number</span></td><td class="attributes"></td><td class="description last"><p>sum of upvotes and downvotes</p></td></tr><tr><td class="name"><code>vote_status</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatVoteString">SidechatVoteString</a></span></td><td class="attributes"></td><td class="description last"><p>current user's vote on post or comment</p></td></tr><tr><td class="name"><code>assets</code></td><td class="type"><span class="param-type">Array.&lt;<a href="global.html#SidechatAsset">SidechatAsset</a>></span></td><td class="attributes"></td><td class="description last"><p>array of assets attached to post or comment</p></td></tr><tr><td class="name"><code>attachments</code></td><td class="type"><span class="param-type">Array</span></td><td class="attributes"></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>dms_disabled</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="attributes"></td><td class="description last"><p>whether or not you can send a DM to creator of post</p></td></tr><tr><td class="name"><code>tags</code></td><td class="type"><span class="param-type">Array</span></td><td class="attributes"></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>identity</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatIdentity">SidechatIdentity</a></span></td><td class="attributes"></td><td class="description last"><p>creator's identity information</p></td></tr><tr><td class="name"><code>pinned</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="attributes"></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>is_saved</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="attributes"></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>follow_status</code></td><td class="type"><span class="param-type">"following"</span> |<wbr> <span class="param-type">"not_following"</span></td><td class="attributes"></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>destination</code></td><td class="type"><span class="param-type">"group"</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>comment_count</code></td><td class="type"><span class="param-type">Number</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>number of comments on post (only if type=post)</p></td></tr><tr><td class="name"><code>comments_disabled</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>whether or not you can comment on post (only if type=post)</p></td></tr><tr><td class="name"><code>parent_post_id</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>alphanumeric ID of parent post (only if type=comment)</p></td></tr><tr><td class="name"><code>reply_post_id</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)</p></td></tr><tr><td class="name"><code>context</code></td><td class="type"><span class="param-type">String</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>text content of comment being replied to, falls back to text (only if type=comment)</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line1">line 1</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatPostsAndCursor">SidechatPostsAndCursor</h3><div class="description"><p>A list of posts and the associated cursor</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>posts</code></td><td class="type"><span class="param-type">Array.&lt;<a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a>></span></td><td class="description last"></td></tr><tr><td class="name"><code>cursor</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatCursorString">SidechatCursorString</a></span></td><td class="description last"></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line86">line 86</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatPrivateAssetURL">SidechatPrivateAssetURL</h3><div class="description"><p>An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">String</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line66">line 66</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatVoteString">SidechatVoteString</h3><div class="description"><p>A vote on a comment or post</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">"upvote"</span> |<wbr> <span class="param-type">"downvote"</span> |<wbr> <span class="param-type">"none"</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="types_SidechatTypes.js.html">types/SidechatTypes.js</a>, <a href="types_SidechatTypes.js.html#line76">line 76</a></li></ul></dd></div></dl></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#SidechatAsset">SidechatAsset</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#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#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.0.4/index.html DELETED
@@ -1,4 +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>Sidechat.js Documentation</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#SidechatAsset">SidechatAsset</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#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#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 class="readme"><article><h1 id="sidechat.js">sidechat.js</h1><p><a href="https://npmjs.com/package/sidechat.js"><img src="https://img.shields.io/npm/dt/sidechat.js?label=downloads%20on%20npm" alt="NPM Downloads"></a></p><p>A reverse-engineered API wrapper for <a href="https://sidechat.lol">Sidechat</a> in Node. Easy to use, documented with JSDoc, and kept up to date as much as possible. Designed for <a href="https://github.com/micahlt/offsides">Offsides</a>, a third-party Sidechat client for Android devices. Documentation can be found <a href="https://micahlindley.com/sidechat.js">here</a>.</p><h2 id="getting-started">Getting Started</h2><blockquote><p>Note: sidechat.js uses the Fetch API released in Node.js 18. If you're attempting to use it in a lower version of Node you will have to polyfill the fetch requests yourself.</p></blockquote><p>Install sidechat.js with your preferred package manager:</p><pre class="prettyprint source lang-bash"><code>$ npm install sidechat.js
4
- </code></pre><p>Next, take a look at the <a href="tutorial-Authentication.html">authentication tutorial</a> to find out how to log your client in and begin making requests.</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#SidechatAsset">SidechatAsset</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#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#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>