sidechat.js 2.3.6 → 2.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (269) hide show
  1. package/dist/classes/SidechatAPIClient.d.ts +8 -0
  2. package/dist/classes/SidechatAPIClient.d.ts.map +1 -1
  3. package/dist/classes/SidechatColorList.d.ts +7 -5
  4. package/dist/classes/SidechatColorList.d.ts.map +1 -1
  5. package/dist/index.cjs +39 -7
  6. package/dist/index.mjs +39 -7
  7. package/docs/sidechat.js/2.3.8/SidechatAPIClient.html +3 -0
  8. package/docs/sidechat.js/2.3.8/SidechatAPIError.html +3 -0
  9. package/docs/sidechat.js/{2.2.0/classes_SidechatAPIError.js.html → 2.3.8/SidechatColorList.html} +2 -15
  10. package/docs/sidechat.js/{2.3.1 → 2.3.8}/classes_SidechatAPIClient.js.html +237 -6
  11. package/docs/sidechat.js/{2.0.4 → 2.3.8}/classes_SidechatAPIError.js.html +2 -2
  12. package/docs/sidechat.js/{2.0.6/classes_SidechatAPIError.js.html → 2.3.8/classes_SidechatColorList.js.html} +75 -12
  13. package/docs/sidechat.js/2.3.8/data/search.json +1 -0
  14. package/docs/sidechat.js/2.3.8/global.html +3 -0
  15. package/docs/sidechat.js/{2.2.0 → 2.3.8}/index.html +2 -2
  16. package/docs/sidechat.js/{2.0.4 → 2.3.8}/tutorial-Authentication.html +4 -3
  17. package/docs/sidechat.js/{2.0.4 → 2.3.8}/tutorial-Email Registration.html +2 -2
  18. package/docs/sidechat.js/{2.2.1 → 2.3.8}/types_SidechatTypes.js.html +2 -2
  19. package/package.json +1 -1
  20. package/src/classes/SidechatAPIClient.js +34 -1
  21. package/src/classes/SidechatColorList.js +5 -6
  22. package/docs/sidechat.js/2.0.4/SidechatAPIClient.html +0 -3
  23. package/docs/sidechat.js/2.0.4/SidechatAPIError.html +0 -3
  24. package/docs/sidechat.js/2.0.4/classes_SidechatAPIClient.js.html +0 -425
  25. package/docs/sidechat.js/2.0.4/data/search.json +0 -1
  26. package/docs/sidechat.js/2.0.4/global.html +0 -3
  27. package/docs/sidechat.js/2.0.4/index.html +0 -4
  28. package/docs/sidechat.js/2.0.4/types_SidechatTypes.js.html +0 -98
  29. package/docs/sidechat.js/2.0.6/SidechatAPIClient.html +0 -3
  30. package/docs/sidechat.js/2.0.6/SidechatAPIError.html +0 -3
  31. package/docs/sidechat.js/2.0.6/classes_SidechatAPIClient.js.html +0 -462
  32. package/docs/sidechat.js/2.0.6/data/search.json +0 -1
  33. package/docs/sidechat.js/2.0.6/fonts/Inconsolata-Regular.ttf +0 -0
  34. package/docs/sidechat.js/2.0.6/fonts/OpenSans-Regular.ttf +0 -0
  35. package/docs/sidechat.js/2.0.6/fonts/WorkSans-Bold.ttf +0 -0
  36. package/docs/sidechat.js/2.0.6/global.html +0 -3
  37. package/docs/sidechat.js/2.0.6/index.html +0 -4
  38. package/docs/sidechat.js/2.0.6/scripts/core.js +0 -702
  39. package/docs/sidechat.js/2.0.6/scripts/core.min.js +0 -23
  40. package/docs/sidechat.js/2.0.6/scripts/resize.js +0 -90
  41. package/docs/sidechat.js/2.0.6/scripts/search.js +0 -265
  42. package/docs/sidechat.js/2.0.6/scripts/search.min.js +0 -6
  43. package/docs/sidechat.js/2.0.6/scripts/third-party/Apache-License-2.0.txt +0 -202
  44. package/docs/sidechat.js/2.0.6/scripts/third-party/fuse.js +0 -9
  45. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-line-num-original.js +0 -369
  46. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-line-num.js +0 -1
  47. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-original.js +0 -5171
  48. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs.js +0 -1
  49. package/docs/sidechat.js/2.0.6/scripts/third-party/popper.js +0 -5
  50. package/docs/sidechat.js/2.0.6/scripts/third-party/tippy.js +0 -1
  51. package/docs/sidechat.js/2.0.6/scripts/third-party/tocbot.js +0 -672
  52. package/docs/sidechat.js/2.0.6/scripts/third-party/tocbot.min.js +0 -1
  53. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-base.css +0 -975
  54. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-dark.css +0 -407
  55. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-light.css +0 -388
  56. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme.min.css +0 -1
  57. package/docs/sidechat.js/2.0.6/tutorial-Authentication.html +0 -13
  58. package/docs/sidechat.js/2.0.6/tutorial-Email Registration.html +0 -6
  59. package/docs/sidechat.js/2.0.6/types_SidechatTypes.js.html +0 -114
  60. package/docs/sidechat.js/2.1.0/SidechatAPIClient.html +0 -3
  61. package/docs/sidechat.js/2.1.0/SidechatAPIError.html +0 -3
  62. package/docs/sidechat.js/2.1.0/classes_SidechatAPIClient.js.html +0 -528
  63. package/docs/sidechat.js/2.1.0/classes_SidechatAPIError.js.html +0 -16
  64. package/docs/sidechat.js/2.1.0/data/search.json +0 -1
  65. package/docs/sidechat.js/2.1.0/fonts/Inconsolata-Regular.ttf +0 -0
  66. package/docs/sidechat.js/2.1.0/fonts/OpenSans-Regular.ttf +0 -0
  67. package/docs/sidechat.js/2.1.0/fonts/WorkSans-Bold.ttf +0 -0
  68. package/docs/sidechat.js/2.1.0/global.html +0 -3
  69. package/docs/sidechat.js/2.1.0/index.html +0 -4
  70. package/docs/sidechat.js/2.1.0/scripts/core.js +0 -702
  71. package/docs/sidechat.js/2.1.0/scripts/core.min.js +0 -23
  72. package/docs/sidechat.js/2.1.0/scripts/resize.js +0 -90
  73. package/docs/sidechat.js/2.1.0/scripts/search.js +0 -265
  74. package/docs/sidechat.js/2.1.0/scripts/search.min.js +0 -6
  75. package/docs/sidechat.js/2.1.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  76. package/docs/sidechat.js/2.1.0/scripts/third-party/fuse.js +0 -9
  77. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-line-num-original.js +0 -369
  78. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-line-num.js +0 -1
  79. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-original.js +0 -5171
  80. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs.js +0 -1
  81. package/docs/sidechat.js/2.1.0/scripts/third-party/popper.js +0 -5
  82. package/docs/sidechat.js/2.1.0/scripts/third-party/tippy.js +0 -1
  83. package/docs/sidechat.js/2.1.0/scripts/third-party/tocbot.js +0 -672
  84. package/docs/sidechat.js/2.1.0/scripts/third-party/tocbot.min.js +0 -1
  85. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-base.css +0 -975
  86. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-dark.css +0 -407
  87. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-light.css +0 -388
  88. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme.min.css +0 -1
  89. package/docs/sidechat.js/2.1.0/tutorial-Authentication.html +0 -13
  90. package/docs/sidechat.js/2.1.0/tutorial-Email Registration.html +0 -6
  91. package/docs/sidechat.js/2.1.0/types_SidechatTypes.js.html +0 -134
  92. package/docs/sidechat.js/2.2.0/SidechatAPIClient.html +0 -3
  93. package/docs/sidechat.js/2.2.0/SidechatAPIError.html +0 -3
  94. package/docs/sidechat.js/2.2.0/classes_SidechatAPIClient.js.html +0 -651
  95. package/docs/sidechat.js/2.2.0/data/search.json +0 -1
  96. package/docs/sidechat.js/2.2.0/fonts/Inconsolata-Regular.ttf +0 -0
  97. package/docs/sidechat.js/2.2.0/fonts/OpenSans-Regular.ttf +0 -0
  98. package/docs/sidechat.js/2.2.0/fonts/WorkSans-Bold.ttf +0 -0
  99. package/docs/sidechat.js/2.2.0/global.html +0 -3
  100. package/docs/sidechat.js/2.2.0/scripts/core.js +0 -702
  101. package/docs/sidechat.js/2.2.0/scripts/core.min.js +0 -23
  102. package/docs/sidechat.js/2.2.0/scripts/resize.js +0 -90
  103. package/docs/sidechat.js/2.2.0/scripts/search.js +0 -265
  104. package/docs/sidechat.js/2.2.0/scripts/search.min.js +0 -6
  105. package/docs/sidechat.js/2.2.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  106. package/docs/sidechat.js/2.2.0/scripts/third-party/fuse.js +0 -9
  107. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-line-num-original.js +0 -369
  108. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-line-num.js +0 -1
  109. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-original.js +0 -5171
  110. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs.js +0 -1
  111. package/docs/sidechat.js/2.2.0/scripts/third-party/popper.js +0 -5
  112. package/docs/sidechat.js/2.2.0/scripts/third-party/tippy.js +0 -1
  113. package/docs/sidechat.js/2.2.0/scripts/third-party/tocbot.js +0 -672
  114. package/docs/sidechat.js/2.2.0/scripts/third-party/tocbot.min.js +0 -1
  115. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-base.css +0 -975
  116. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-dark.css +0 -407
  117. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-light.css +0 -388
  118. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme.min.css +0 -1
  119. package/docs/sidechat.js/2.2.0/tutorial-Authentication.html +0 -14
  120. package/docs/sidechat.js/2.2.0/tutorial-Email Registration.html +0 -6
  121. package/docs/sidechat.js/2.2.0/types_SidechatTypes.js.html +0 -134
  122. package/docs/sidechat.js/2.2.1/SidechatAPIClient.html +0 -3
  123. package/docs/sidechat.js/2.2.1/SidechatAPIError.html +0 -3
  124. package/docs/sidechat.js/2.2.1/classes_SidechatAPIClient.js.html +0 -688
  125. package/docs/sidechat.js/2.2.1/classes_SidechatAPIError.js.html +0 -16
  126. package/docs/sidechat.js/2.2.1/data/search.json +0 -1
  127. package/docs/sidechat.js/2.2.1/fonts/Inconsolata-Regular.ttf +0 -0
  128. package/docs/sidechat.js/2.2.1/fonts/OpenSans-Regular.ttf +0 -0
  129. package/docs/sidechat.js/2.2.1/fonts/WorkSans-Bold.ttf +0 -0
  130. package/docs/sidechat.js/2.2.1/global.html +0 -3
  131. package/docs/sidechat.js/2.2.1/index.html +0 -4
  132. package/docs/sidechat.js/2.2.1/scripts/core.js +0 -702
  133. package/docs/sidechat.js/2.2.1/scripts/core.min.js +0 -23
  134. package/docs/sidechat.js/2.2.1/scripts/resize.js +0 -90
  135. package/docs/sidechat.js/2.2.1/scripts/search.js +0 -265
  136. package/docs/sidechat.js/2.2.1/scripts/search.min.js +0 -6
  137. package/docs/sidechat.js/2.2.1/scripts/third-party/Apache-License-2.0.txt +0 -202
  138. package/docs/sidechat.js/2.2.1/scripts/third-party/fuse.js +0 -9
  139. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-line-num-original.js +0 -369
  140. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-line-num.js +0 -1
  141. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-original.js +0 -5171
  142. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs.js +0 -1
  143. package/docs/sidechat.js/2.2.1/scripts/third-party/popper.js +0 -5
  144. package/docs/sidechat.js/2.2.1/scripts/third-party/tippy.js +0 -1
  145. package/docs/sidechat.js/2.2.1/scripts/third-party/tocbot.js +0 -672
  146. package/docs/sidechat.js/2.2.1/scripts/third-party/tocbot.min.js +0 -1
  147. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-base.css +0 -975
  148. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-dark.css +0 -407
  149. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-light.css +0 -388
  150. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme.min.css +0 -1
  151. package/docs/sidechat.js/2.2.1/tutorial-Authentication.html +0 -14
  152. package/docs/sidechat.js/2.2.1/tutorial-Email Registration.html +0 -6
  153. package/docs/sidechat.js/2.2.3/SidechatAPIClient.html +0 -3
  154. package/docs/sidechat.js/2.2.3/SidechatAPIError.html +0 -3
  155. package/docs/sidechat.js/2.2.3/classes_SidechatAPIClient.js.html +0 -689
  156. package/docs/sidechat.js/2.2.3/classes_SidechatAPIError.js.html +0 -16
  157. package/docs/sidechat.js/2.2.3/data/search.json +0 -1
  158. package/docs/sidechat.js/2.2.3/fonts/Inconsolata-Regular.ttf +0 -0
  159. package/docs/sidechat.js/2.2.3/fonts/OpenSans-Regular.ttf +0 -0
  160. package/docs/sidechat.js/2.2.3/fonts/WorkSans-Bold.ttf +0 -0
  161. package/docs/sidechat.js/2.2.3/global.html +0 -3
  162. package/docs/sidechat.js/2.2.3/index.html +0 -4
  163. package/docs/sidechat.js/2.2.3/scripts/core.js +0 -702
  164. package/docs/sidechat.js/2.2.3/scripts/core.min.js +0 -23
  165. package/docs/sidechat.js/2.2.3/scripts/resize.js +0 -90
  166. package/docs/sidechat.js/2.2.3/scripts/search.js +0 -265
  167. package/docs/sidechat.js/2.2.3/scripts/search.min.js +0 -6
  168. package/docs/sidechat.js/2.2.3/scripts/third-party/Apache-License-2.0.txt +0 -202
  169. package/docs/sidechat.js/2.2.3/scripts/third-party/fuse.js +0 -9
  170. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-line-num-original.js +0 -369
  171. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-line-num.js +0 -1
  172. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-original.js +0 -5171
  173. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs.js +0 -1
  174. package/docs/sidechat.js/2.2.3/scripts/third-party/popper.js +0 -5
  175. package/docs/sidechat.js/2.2.3/scripts/third-party/tippy.js +0 -1
  176. package/docs/sidechat.js/2.2.3/scripts/third-party/tocbot.js +0 -672
  177. package/docs/sidechat.js/2.2.3/scripts/third-party/tocbot.min.js +0 -1
  178. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-base.css +0 -975
  179. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-dark.css +0 -407
  180. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-light.css +0 -388
  181. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme.min.css +0 -1
  182. package/docs/sidechat.js/2.2.3/tutorial-Authentication.html +0 -14
  183. package/docs/sidechat.js/2.2.3/tutorial-Email Registration.html +0 -6
  184. package/docs/sidechat.js/2.2.3/types_SidechatTypes.js.html +0 -134
  185. package/docs/sidechat.js/2.3.0/SidechatAPIClient.html +0 -3
  186. package/docs/sidechat.js/2.3.0/SidechatAPIError.html +0 -3
  187. package/docs/sidechat.js/2.3.0/classes_SidechatAPIClient.js.html +0 -720
  188. package/docs/sidechat.js/2.3.0/classes_SidechatAPIError.js.html +0 -16
  189. package/docs/sidechat.js/2.3.0/data/search.json +0 -1
  190. package/docs/sidechat.js/2.3.0/fonts/Inconsolata-Regular.ttf +0 -0
  191. package/docs/sidechat.js/2.3.0/fonts/OpenSans-Regular.ttf +0 -0
  192. package/docs/sidechat.js/2.3.0/fonts/WorkSans-Bold.ttf +0 -0
  193. package/docs/sidechat.js/2.3.0/global.html +0 -3
  194. package/docs/sidechat.js/2.3.0/index.html +0 -4
  195. package/docs/sidechat.js/2.3.0/scripts/core.js +0 -702
  196. package/docs/sidechat.js/2.3.0/scripts/core.min.js +0 -23
  197. package/docs/sidechat.js/2.3.0/scripts/resize.js +0 -90
  198. package/docs/sidechat.js/2.3.0/scripts/search.js +0 -265
  199. package/docs/sidechat.js/2.3.0/scripts/search.min.js +0 -6
  200. package/docs/sidechat.js/2.3.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  201. package/docs/sidechat.js/2.3.0/scripts/third-party/fuse.js +0 -9
  202. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-line-num-original.js +0 -369
  203. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-line-num.js +0 -1
  204. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-original.js +0 -5171
  205. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs.js +0 -1
  206. package/docs/sidechat.js/2.3.0/scripts/third-party/popper.js +0 -5
  207. package/docs/sidechat.js/2.3.0/scripts/third-party/tippy.js +0 -1
  208. package/docs/sidechat.js/2.3.0/scripts/third-party/tocbot.js +0 -672
  209. package/docs/sidechat.js/2.3.0/scripts/third-party/tocbot.min.js +0 -1
  210. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-base.css +0 -975
  211. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-dark.css +0 -407
  212. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-light.css +0 -388
  213. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme.min.css +0 -1
  214. package/docs/sidechat.js/2.3.0/tutorial-Authentication.html +0 -14
  215. package/docs/sidechat.js/2.3.0/tutorial-Email Registration.html +0 -6
  216. package/docs/sidechat.js/2.3.0/types_SidechatTypes.js.html +0 -134
  217. package/docs/sidechat.js/2.3.1/SidechatAPIClient.html +0 -3
  218. package/docs/sidechat.js/2.3.1/SidechatAPIError.html +0 -3
  219. package/docs/sidechat.js/2.3.1/classes_SidechatAPIError.js.html +0 -16
  220. package/docs/sidechat.js/2.3.1/data/search.json +0 -1
  221. package/docs/sidechat.js/2.3.1/fonts/Inconsolata-Regular.ttf +0 -0
  222. package/docs/sidechat.js/2.3.1/fonts/OpenSans-Regular.ttf +0 -0
  223. package/docs/sidechat.js/2.3.1/fonts/WorkSans-Bold.ttf +0 -0
  224. package/docs/sidechat.js/2.3.1/global.html +0 -3
  225. package/docs/sidechat.js/2.3.1/index.html +0 -4
  226. package/docs/sidechat.js/2.3.1/scripts/core.js +0 -702
  227. package/docs/sidechat.js/2.3.1/scripts/core.min.js +0 -23
  228. package/docs/sidechat.js/2.3.1/scripts/resize.js +0 -90
  229. package/docs/sidechat.js/2.3.1/scripts/search.js +0 -265
  230. package/docs/sidechat.js/2.3.1/scripts/search.min.js +0 -6
  231. package/docs/sidechat.js/2.3.1/scripts/third-party/Apache-License-2.0.txt +0 -202
  232. package/docs/sidechat.js/2.3.1/scripts/third-party/fuse.js +0 -9
  233. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-line-num-original.js +0 -369
  234. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-line-num.js +0 -1
  235. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-original.js +0 -5171
  236. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs.js +0 -1
  237. package/docs/sidechat.js/2.3.1/scripts/third-party/popper.js +0 -5
  238. package/docs/sidechat.js/2.3.1/scripts/third-party/tippy.js +0 -1
  239. package/docs/sidechat.js/2.3.1/scripts/third-party/tocbot.js +0 -672
  240. package/docs/sidechat.js/2.3.1/scripts/third-party/tocbot.min.js +0 -1
  241. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-base.css +0 -975
  242. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-dark.css +0 -407
  243. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-light.css +0 -388
  244. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme.min.css +0 -1
  245. package/docs/sidechat.js/2.3.1/tutorial-Authentication.html +0 -14
  246. package/docs/sidechat.js/2.3.1/tutorial-Email Registration.html +0 -6
  247. package/docs/sidechat.js/2.3.1/types_SidechatTypes.js.html +0 -134
  248. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/fonts/Inconsolata-Regular.ttf +0 -0
  249. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/fonts/OpenSans-Regular.ttf +0 -0
  250. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/fonts/WorkSans-Bold.ttf +0 -0
  251. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/core.js +0 -0
  252. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/core.min.js +0 -0
  253. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/resize.js +0 -0
  254. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/search.js +0 -0
  255. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/search.min.js +0 -0
  256. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/Apache-License-2.0.txt +0 -0
  257. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/fuse.js +0 -0
  258. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/hljs-line-num-original.js +0 -0
  259. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/hljs-line-num.js +0 -0
  260. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/hljs-original.js +0 -0
  261. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/hljs.js +0 -0
  262. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/popper.js +0 -0
  263. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/tippy.js +0 -0
  264. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/tocbot.js +0 -0
  265. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/scripts/third-party/tocbot.min.js +0 -0
  266. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/styles/clean-jsdoc-theme-base.css +0 -0
  267. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/styles/clean-jsdoc-theme-dark.css +0 -0
  268. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/styles/clean-jsdoc-theme-light.css +0 -0
  269. /package/docs/sidechat.js/{2.0.4 → 2.3.8}/styles/clean-jsdoc-theme.min.css +0 -0
package/docs/sidechat.js/2.3.0/classes_SidechatAPIClient.js.html DELETED
@@ -1,720 +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#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCurrentUser">SidechatCurrentUser</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatMembership">SidechatMembership</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section 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
- * @constant
22
- */
23
- defaultHeaders = {
24
- Accept: "application/json",
25
- "Content-Type": "application/json",
26
- "App-Version": "10.0.0",
27
- Dnt: 1,
28
- };
29
-
30
- /**
31
- * Create a new instance of the API client
32
- * @param {SidechatAuthToken} [token] - user bearer token
33
- */
34
- constructor(token = "") {
35
- if (token) {
36
- this.userToken = token;
37
- }
38
- }
39
-
40
- /**
41
- * 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
42
- * @method
43
- * @param {SidechatAuthToken} token - user bearer token
44
- */
45
- setToken = (token) => {
46
- this.userToken = token;
47
- };
48
-
49
- /**
50
- * Initiate the login process with a phone number. Should be followed up with verifySMSCode().
51
- * @method
52
- * @since 1.0.0
53
- * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
54
- */
55
- loginViaSMS = async (phoneNumber) => {
56
- try {
57
- const res = await fetch(`https://api.sidechat.lol/v1/login_register`, {
58
- method: "POST",
59
- headers: this.defaultHeaders,
60
- body: JSON.stringify({
61
- phone_number: `+1${phoneNumber}`,
62
- version: 3,
63
- }),
64
- });
65
- const json = await res.json();
66
- return json;
67
- } catch (err) {
68
- console.error(err);
69
- throw new SidechatAPIError("Failed to request SMS verification.");
70
- }
71
- };
72
-
73
- /**
74
- * Verify the code sent via SMS with loginViaSMS(). If this function succeeds, the user will be authenticated for future requests.
75
- * @method
76
- * @since 1.0.0
77
- * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
78
- * @param {String} code - the verification code
79
- */
80
- verifySMSCode = async (phoneNumber, code) => {
81
- try {
82
- const res = await fetch(
83
- `https://api.sidechat.lol/v1/verify_phone_number`,
84
- {
85
- method: "POST",
86
- headers: this.defaultHeaders,
87
- body: JSON.stringify({
88
- phone_number: `+1${phoneNumber}`,
89
- code: code.toUpperCase(),
90
- }),
91
- }
92
- );
93
- const json = await res.json();
94
- if (json?.logged_in_user?.token) {
95
- this.userToken = json.logged_in_user.token;
96
- }
97
- return json;
98
- } catch (err) {
99
- console.error(err);
100
- throw new SidechatAPIError("Failed verify this code.");
101
- }
102
- };
103
-
104
- /**
105
- * Set the user's age. If this function succeeds, the user will be authenticated for future requests.
106
- * @method
107
- * @since 1.0.0
108
- * @param {Number} age - user's age in years
109
- * @param {String} registrationID - the registration ID generated by verifySMSCode()
110
- */
111
- setAge = async (age, registrationID) => {
112
- if (age &lt; 13) {
113
- throw new SidechatAPIError("You're too young to use Offsides.");
114
- }
115
- try {
116
- const res = await fetch(
117
- `https://api.sidechat.lol/v1/complete_registration`,
118
- {
119
- method: "POST",
120
- headers: this.defaultHeaders,
121
- body: JSON.stringify({
122
- age: Number(age),
123
- registration_id: registrationID,
124
- }),
125
- }
126
- );
127
- const json = await res.json();
128
- if (json.token) {
129
- this.userToken = json.token;
130
- }
131
- return json;
132
- } catch (err) {
133
- console.error(err);
134
- throw new SidechatAPIError("Failed verify this code.");
135
- }
136
- };
137
-
138
- /**
139
- * Initiate the email setup process. Should be followed up with checkEmailVerification().
140
- * @method
141
- * @since 1.0.0
142
- * @param {String} email - school email address to send verification code to
143
- * @tutorial Email Registration
144
- */
145
- registerEmail = async (email) => {
146
- if (!this.userToken) {
147
- throw new SidechatAPIError("User is not authenticated.");
148
- }
149
- try {
150
- const res = await fetch(
151
- `https://api.sidechat.lol/v2/users/register_email`,
152
- {
153
- method: "POST",
154
- headers: {
155
- ...this.defaultHeaders,
156
- Authorization: `Bearer ${this.userToken}`,
157
- },
158
- body: JSON.stringify({
159
- email: email,
160
- }),
161
- }
162
- );
163
- const json = await res.json();
164
- if (json.message) {
165
- throw new SidechatAPIError(json.message);
166
- }
167
- return json;
168
- } catch (err) {
169
- console.error(error);
170
- throw new SidechatAPIError("Failed to request email verification.");
171
- }
172
- };
173
-
174
- /**
175
- * Check is the user's email is verified.
176
- * @method
177
- * @since 1.0.0
178
- */
179
- checkEmailVerification = async () => {
180
- if (!this.userToken) {
181
- throw new SidechatAPIError("User is not authenticated.");
182
- }
183
- try {
184
- const res = await fetch(
185
- `https://api.sidechat.lol/v1/users/check_email_verified`,
186
- {
187
- method: "GET",
188
- headers: {
189
- ...this.defaultHeaders,
190
- Authorization: `Bearer ${this.userToken}`,
191
- },
192
- }
193
- );
194
- const json = await res.json();
195
- if (json.verified_email_updates_response) {
196
- return json.verified_email_updates_response;
197
- } else {
198
- throw new SidechatAPIError(json?.message || "Email is not verified.");
199
- }
200
- } catch (err) {
201
- console.error(error);
202
- throw new SidechatAPIError("Email is not verified.");
203
- }
204
- };
205
-
206
- /**
207
- * Set the device ID of the current user
208
- * @method
209
- * @since 1.0.0
210
- * @param {String} deviceId - the device ID to set
211
- */
212
- setDeviceID = async (deviceID) => {
213
- if (!this.userToken) {
214
- throw new SidechatAPIError("User is not authenticated.");
215
- }
216
- try {
217
- const res = await fetch(
218
- `https://api.sidechat.lol/v1/register_device_token`,
219
- {
220
- method: "POST",
221
- headers: {
222
- ...this.defaultHeaders,
223
- Authorization: `Bearer ${this.userToken}`,
224
- },
225
- body: JSON.stringify({
226
- build_type: "release",
227
- bundle_id: "com.flowerave.sidechat",
228
- device_token: deviceID,
229
- }),
230
- }
231
- );
232
- const json = await res.json();
233
- await AsyncStorage.setItem("deviceID", deviceID);
234
- return json;
235
- } catch (err) {
236
- console.error(err);
237
- throw new SidechatAPIError("Failed verify this code.");
238
- }
239
- };
240
-
241
- /**
242
- * Get updated status for user and group
243
- * @method
244
- * @since 1.0.0
245
- * @deprecated since 2.1.0, will be removed by 3.0.0. Please use `getUpdates` instead!
246
- * @param {String} [groupID] - ID of a specific group to retrieve info from. Falls back to user's primary group.
247
- */
248
- getUserAndGroup = async (groupID = "") => {
249
- const json = await this.getUpdates(groupID);
250
- return json;
251
- };
252
-
253
- /**
254
- * Get updated status for user and group
255
- * @method
256
- * @since 2.1.0
257
- * @param {String} [groupID] - ID of a specific group to retrieve info from. Falls back to user's primary group.
258
- */
259
- getUpdates = async (groupID = "") => {
260
- if (!this.userToken) {
261
- throw new SidechatAPIError("User is not authenticated.");
262
- }
263
- try {
264
- const res = await fetch(
265
- `https://api.sidechat.lol/v1/updates?group_id=${groupID}`,
266
- {
267
- method: "GET",
268
- headers: {
269
- ...this.defaultHeaders,
270
- Authorization: `Bearer ${this.userToken}`,
271
- },
272
- }
273
- );
274
- const json = await res.json();
275
- return json;
276
- } catch (err) {
277
- console.error(err);
278
- throw new SidechatAPIError(`Failed to get posts from group.`);
279
- }
280
- };
281
-
282
- /**
283
- * Fetches posts from the specified category in a group
284
- * @method
285
- * @since 1.0.0
286
- * @param {String} groupID - group ID
287
- * @param {"hot"|"recent"|"top"} category - category to filter posts
288
- * @param {SidechatCursorString} [cursor] - cursor string
289
- * @returns {SidechatPostsAndCursor} List of posts and cursor
290
- */
291
- getGroupPosts = async (groupID, category = "hot", cursor) => {
292
- if (!this.userToken) {
293
- throw new SidechatAPIError("User is not authenticated.");
294
- }
295
- try {
296
- const res = await fetch(
297
- `https://api.sidechat.lol/v1/posts?group_id=${groupID}&amp;type=${category}${
298
- cursor ? "&amp;cursor=" + cursor : ""
299
- }`,
300
- {
301
- method: "GET",
302
- headers: {
303
- ...this.defaultHeaders,
304
- Authorization: `Bearer ${this.userToken}`,
305
- },
306
- }
307
- );
308
- const json = await res.json();
309
- return json;
310
- } catch (err) {
311
- console.error(err);
312
- throw new SidechatAPIError(`Failed to get posts from group.`);
313
- }
314
- };
315
-
316
- /**
317
- * Upvote or downvote, or unvote a post
318
- * @method
319
- * @since 2.0.0-alpha.0
320
- * @param {String} postID - post ID to vote on
321
- * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote
322
- */
323
- setVote = async (postID, action) => {
324
- if (!this.userToken) {
325
- throw new SidechatAPIError("User is not authenticated.");
326
- }
327
- try {
328
- const res = await fetch(`https://api.sidechat.lol/v1/posts/set_vote`, {
329
- method: "POST",
330
- headers: {
331
- ...this.defaultHeaders,
332
- Authorization: `Bearer ${this.userToken}`,
333
- },
334
- body: JSON.stringify({
335
- post_id: postID,
336
- vote_status: action,
337
- }),
338
- });
339
- const json = await res.json();
340
- return json;
341
- } catch (err) {
342
- console.error(err);
343
- throw new SidechatAPIError(`Failed to change the vote on post.`);
344
- }
345
- };
346
-
347
- /**
348
- * Fetches a single post with just its ID
349
- * @method
350
- * @since 2.3.0
351
- * @param {String} postID - ID of post to fetch
352
- * @returns {SidechatPostOrComment} post object
353
- */
354
- getPost = async (postID) => {
355
- if (!this.userToken) {
356
- throw new SidechatAPIError("User is not authenticated.");
357
- }
358
- try {
359
- const res = await fetch(
360
- `https://api.sidechat.lol/v1/posts/get?include_deleted=${includeDeleted}&amp;post_id=${postID}`,
361
- {
362
- method: "GET",
363
- headers: {
364
- ...this.defaultHeaders,
365
- Authorization: `Bearer ${this.userToken}`,
366
- },
367
- }
368
- );
369
- const json = await res.json();
370
- return json.post;
371
- } catch (err) {
372
- console.error(err);
373
- throw new SidechatAPIError(`Failed to get post from ID.`);
374
- }
375
- };
376
-
377
- /**
378
- * Get all the commments on a post
379
- * @method
380
- * @since 2.0.0-alpha.0
381
- * @param {String} postID - post ID to get comments for
382
- * @returns {SidechatPostOrComment[]} list of comments
383
- */
384
- getPostComments = async (postID) => {
385
- if (!this.userToken) {
386
- throw new SidechatAPIError("User is not authenticated.");
387
- }
388
- try {
389
- const res = await fetch(
390
- `https://api.sidechat.lol/v1/posts/comments/?post_id=${postID}`,
391
- {
392
- method: "GET",
393
- headers: {
394
- ...this.defaultHeaders,
395
- Authorization: `Bearer ${this.userToken}`,
396
- },
397
- }
398
- );
399
- const json = await res.json();
400
- // Function to preprocess the comments and organize them into a nested structure
401
- function preprocessComments(apiComments) {
402
- // Map to store comments by their IDs for efficient lookup
403
- const commentMap = new Map();
404
- // List to store top-level comments
405
- const topLevelComments = [];
406
-
407
- // Iterate through the API comments
408
- apiComments.forEach((comment) => {
409
- // Store the comment in the map with its ID as the key
410
- commentMap.set(comment.id, comment);
411
- // Get the parent comment using the reply_post_id
412
- const parentComment = commentMap.get(comment.reply_post_id);
413
- // Check if the comment is a top-level comment
414
- if (
415
- !parentComment ||
416
- comment.reply_post_id === comment.parent_post_id
417
- ) {
418
- // If it's a top-level comment, push it to the topLevelComments array
419
- topLevelComments.push(comment);
420
- } else {
421
- // If it's a reply, add it to the parent comment's replies array
422
- if (!parentComment.replies) parentComment.replies = [];
423
- parentComment.replies.push(comment);
424
- }
425
- });
426
-
427
- // Flatten the nested structure and return a single list of comments
428
- return flattenComments(topLevelComments);
429
- }
430
-
431
- // Function to flatten nested comments into a single list
432
- function flattenComments(comments) {
433
- // Use reduce to flatten the nested comments array into a single list
434
- return comments.reduce((flatComments, comment) => {
435
- // Push the current comment to the flatComments array
436
- flatComments.push(comment);
437
- // If the current comment has replies, recursively flatten them and push to the flatComments array
438
- if (comment.replies)
439
- flatComments.push(...flattenComments(comment.replies));
440
- // Return the flatComments array
441
- return flatComments;
442
- }, []);
443
- }
444
-
445
- const sortedComments = preprocessComments(json.posts);
446
- return sortedComments;
447
- } catch (err) {
448
- console.error(err);
449
- throw new SidechatAPIError(`Failed to get comments on post.`);
450
- }
451
- };
452
-
453
- /**
454
- * Gets groups to be displayed on the "Explore Groups" page
455
- * @method
456
- * @since 2.0.0-alpha.0
457
- * @returns {SidechatGroup[]}
458
- */
459
- getAvailableGroups = async () => {
460
- if (!this.userToken) {
461
- throw new SidechatAPIError("User is not authenticated.");
462
- }
463
- try {
464
- const res = await fetch(`https://api.sidechat.lol/v1/groups/explore`, {
465
- method: "GET",
466
- headers: {
467
- ...this.defaultHeaders,
468
- Authorization: `Bearer ${this.userToken}`,
469
- },
470
- });
471
- const json = await res.json();
472
- return await json.groups;
473
- } catch (err) {
474
- console.error(err);
475
- throw new SidechatAPIError(`Failed to get groups from explore.`);
476
- }
477
- };
478
-
479
- /**
480
- * Retrieves the entire accessible asset library. Be warned that as of the time of this documentation, it's a 1.5MB JSON download and this request is very expensive.
481
- * @method
482
- * @since 2.0.6
483
- * @returns {SidechatLibraryAsset[]}
484
- */
485
- getAssetLibrary = async () => {
486
- if (!this.userToken) {
487
- throw new SidechatAPIError("User is not authenticated.");
488
- }
489
- try {
490
- const res = await fetch(`https://api.sidechat.lol/v1/assets/library`, {
491
- method: "GET",
492
- headers: {
493
- ...this.defaultHeaders,
494
- Authorization: `Bearer ${this.userToken}`,
495
- },
496
- });
497
- const json = await res.json();
498
- return await json.items;
499
- } catch (err) {
500
- console.error(err);
501
- throw new SidechatAPIError(`Failed to get asset library.`);
502
- }
503
- };
504
-
505
- /**
506
- * Gets the current authenticated user and a list of the groups of which they are members.
507
- * @method
508
- * @since 2.1.0
509
- * @returns {SidechatCurrentUser}
510
- */
511
- getCurrentUser = async () => {
512
- if (!this.userToken) {
513
- throw new SidechatAPIError("User is not authenticated.");
514
- }
515
- try {
516
- const res = await fetch(`https://api.sidechat.lol/v1/users/me`, {
517
- method: "GET",
518
- headers: {
519
- ...this.defaultHeaders,
520
- Authorization: `Bearer ${this.userToken}`,
521
- },
522
- });
523
- const json = await res.json();
524
- return await json;
525
- } catch (err) {
526
- console.error(err);
527
- throw new SidechatAPIError(`Failed to get asset library.`);
528
- }
529
- };
530
-
531
- /**
532
- * Gets the metadata of a group from its ID
533
- * @method
534
- * @since 2.1.0
535
- * @param {String} [groupID] - alphanumeric ID of a group to get. Falls back to user's primary group.
536
- * @returns {SidechatGroup}
537
- */
538
- getGroupMetadata = async (groupID = "") => {
539
- if (!this.userToken) {
540
- throw new SidechatAPIError("User is not authenticated.");
541
- }
542
- try {
543
- const res = await fetch(`https://api.sidechat.lol/v1/groups/${groupID}`, {
544
- method: "GET",
545
- headers: {
546
- ...this.defaultHeaders,
547
- Authorization: `Bearer ${this.userToken}`,
548
- },
549
- });
550
- const json = await res.json();
551
- return await json.group;
552
- } catch (err) {
553
- console.error(err);
554
- throw new SidechatAPIError(`Failed to get group metadata.`);
555
- }
556
- };
557
-
558
- /**
559
- * Creates a comment on a post
560
- * @method
561
- * @since 2.2.0
562
- * @param {String} parentPostID - alphanumeric ID of post on which this comment is made
563
- * @param {String} text - text content of comment
564
- * @param {String} groupID - alphanumeric ID of group in which the parent post resides
565
- * @param {String} [replyCommentID] - alphanumeric ID of comment to reply to. Falls back to parentPostID
566
- * @param {SidechatSimpleAsset[]} [assetList] - list of assets to attach
567
- * @param {Boolean} [disableDMs] - prevent direct messages being sent to comment's author
568
- * @returns {SidechatPostOrComment} created comment
569
- */
570
- createComment = async (
571
- parentPostID,
572
- text,
573
- groupID,
574
- replyCommentID = parentPostID,
575
- assetList = [],
576
- disableDMs = false
577
- ) => {
578
- if (!this.userToken) {
579
- throw new SidechatAPIError("User is not authenticated.");
580
- }
581
- try {
582
- const res = await fetch(`https://api.sidechat.lol/v1/posts`, {
583
- method: "POST",
584
- headers: {
585
- ...this.defaultHeaders,
586
- Authorization: `Bearer ${this.userToken}`,
587
- },
588
- body: JSON.stringify({
589
- type: "comment",
590
- assets: assetList,
591
- group_ids: [groupID],
592
- text: text,
593
- reply_post_id: replyCommentID,
594
- parent_post_id: parentPostID,
595
- dms_disabled: disableDMs,
596
- }),
597
- });
598
- const json = await res.json();
599
- return await json.comment;
600
- } catch (err) {
601
- console.error(err);
602
- throw new SidechatAPIError(`Failed to post comment.`);
603
- }
604
- };
605
-
606
- /**
607
- * Creates a new post in the specified group
608
- * @method
609
- * @since 2.2.0
610
- * @param {String} text - text content of comment
611
- * @param {String} groupID - alphanumeric ID of group in which the parent post resides
612
- * @param {SidechatSimpleAsset[]} [assetList] - list of assets to attach.
613
- * @param {Boolean} [disableDMs] - prevent direct messages from being sent to post's author
614
- * @param {Boolean} [disableComments] - whether or not comments should be disabled on post
615
- * @returns {SidechatPostOrComment} the created post
616
- */
617
- createPost = async (
618
- text,
619
- groupID,
620
- assetList = [],
621
- disableDMs = false,
622
- disableComments = false
623
- ) => {
624
- if (!this.userToken) {
625
- throw new SidechatAPIError("User is not authenticated.");
626
- }
627
- try {
628
- const res = await fetch(`https://api.sidechat.lol/v1/posts`, {
629
- method: "POST",
630
- headers: {
631
- ...this.defaultHeaders,
632
- Authorization: `Bearer ${this.userToken}`,
633
- },
634
- body: JSON.stringify({
635
- type: "post",
636
- assets: assetList,
637
- group_ids: [groupID],
638
- text: text,
639
- attachments: [],
640
- dms_disabled: disableDMs,
641
- comments_disabled: disableComments,
642
- }),
643
- });
644
- const json = await res.json();
645
- return await json.posts[0];
646
- } catch (err) {
647
- console.error(err);
648
- throw new SidechatAPIError(`Failed to make post.`);
649
- }
650
- };
651
-
652
- /**
653
- * Deletes a post or comment that the user created
654
- * @method
655
- * @since 2.2.0
656
- * @param {String} postOrCommentID - alphanumeric ID of post to delete
657
- */
658
- deletePostOrComment = async (postOrCommentID) => {
659
- if (!this.userToken) {
660
- throw new SidechatAPIError("User is not authenticated.");
661
- }
662
- try {
663
- const res = await fetch(`https://api.sidechat.lol/v1/posts/delete`, {
664
- method: "POST",
665
- headers: {
666
- ...this.defaultHeaders,
667
- Authorization: `Bearer ${this.userToken}`,
668
- },
669
- body: JSON.stringify({
670
- post_id: postOrCommentID,
671
- }),
672
- });
673
- const json = await res.json();
674
- return await json;
675
- } catch (err) {
676
- console.error(err);
677
- throw new SidechatAPIError(`Failed to delete post.`);
678
- }
679
- };
680
-
681
- /**
682
- * Sets the conversation icon of the current user
683
- * @method
684
- * @since 2.2.1
685
- * @param {String} userID - alphanumeric ID of the post to delete
686
- * @param {String} emoji - emoji to set as icon
687
- * @param {String} primaryColor - hex string (including #) of primary color
688
- * @param {String} secondaryColor - hex string (including #) of secondary color
689
- */
690
- setUserIcon = async (userID, emoji, primaryColor, secondaryColor) => {
691
- if (!this.userToken) {
692
- throw new SidechatAPIError("User is not authenticated.");
693
- }
694
- try {
695
- const res = await fetch(`https://api.sidechat.lol/v1/users/${userID}`, {
696
- method: "PATCH",
697
- headers: {
698
- ...this.defaultHeaders,
699
- Authorization: `Bearer ${this.userToken}`,
700
- },
701
- body: JSON.stringify({
702
- conversation_icon: {
703
- emoji: emoji,
704
- secondary_color: secondaryColor,
705
- is_migrated: true,
706
- color: primaryColor,
707
- },
708
- }),
709
- });
710
- const json = await res.json();
711
- return await json;
712
- } catch (err) {
713
- console.error(err);
714
- throw new SidechatAPIError(`Failed to set icon.`);
715
- }
716
- };
717
- }
718
-
719
- export default SidechatAPIClient;
720
- </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#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCurrentUser">SidechatCurrentUser</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatMembership">SidechatMembership</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>