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.1.0/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#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><article><div class="container-overview"></div><h2 id="type-definitions" class="subsection-title has-anchor">Type Definitions</h2><h3 class="name has-anchor" id="SidechatAssetMetadata">SidechatAssetMetadata</h3><div class="description"><p>An asset object, containing information about an image from the asset library</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>width</code></td><td class="type"><span class="param-type">Number</span></td><td class="description last"><p>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>height 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></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#line68">line 68</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#line119">line 119</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatCurrentUser">SidechatCurrentUser</h3><div class="description"><p>The current user's 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>id</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>alphanumeric ID of current user</p></td></tr><tr><td class="name"><code>hashedVerifiedEmail</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>verified email of current user in an unreadable hashed form</p></td></tr><tr><td class="name"><code>isGlobalModerator</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="description last"><p>whether or not user is a moderator</p></td></tr><tr><td class="name"><code>isGlobalAdmin</code></td><td class="type"><span class="param-type">Boolean</span></td><td class="description last"><p>whether or not user is an admin</p></td></tr><tr><td class="name"><code>memberships</code></td><td class="type"><span class="param-type">Array.&lt;<a href="global.html#SidechatMembership">SidechatMembership</a>></span></td><td class="description last"></td></tr><tr><td class="name"><code>roles</code></td><td class="type"><span class="param-type">Array</span></td><td class="description last"><p>undocumented</p></td></tr><tr><td class="name"><code>emailDomain</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>domain of verified email address on account</p></td></tr><tr><td class="name"><code>wildcardEmailDomain</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>domain of verified email address on account, preceeded by *. to support subdomains</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#line84">line 84</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#line109">line 109</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. Some properties vary based on the endpoint the object came from.</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 anonymous 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#line77">line 77</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatLibraryAsset">SidechatLibraryAsset</h3><div class="description"><p>An asset object, containing information about an image from the asset library</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>created_at</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>date string of asset creation time</p></td></tr><tr><td class="name"><code>metadata</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></span></td><td class="description last"><p>metadata associated with 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#line59">line 59</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatMembership">SidechatMembership</h3><div class="description"><p>Representation of a group membership</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>groupId</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>alphanumeric ID of group</p></td></tr><tr><td class="name"><code>type</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>role of current user in group</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#line97">line 97</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#SidechatSimpleAsset">SidechatSimpleAsset</a>></span></td><td class="attributes"></td><td class="description last"><p>array of simple 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#line124">line 124</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#line104">line 104</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="SidechatSimpleAsset">SidechatSimpleAsset</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>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>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="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#line114">line 114</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#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>
package/docs/sidechat.js/2.1.0/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#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 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#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>