sidechat.js 2.3.7 → 2.4.0

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 (270) hide show
  1. package/dist/classes/SidechatAPIClient.d.ts +23 -1
  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 +132 -96
  6. package/dist/index.mjs +132 -96
  7. package/docs/sidechat.js/2.4.0/SidechatAPIClient.html +3 -0
  8. package/docs/sidechat.js/2.4.0/SidechatAPIError.html +3 -0
  9. package/docs/sidechat.js/{2.2.0/classes_SidechatAPIError.js.html → 2.4.0/SidechatColorList.html} +2 -15
  10. package/docs/sidechat.js/{2.3.1 → 2.4.0}/classes_SidechatAPIClient.js.html +316 -81
  11. package/docs/sidechat.js/{2.0.4 → 2.4.0}/classes_SidechatAPIError.js.html +2 -2
  12. package/docs/sidechat.js/{2.0.6/classes_SidechatAPIError.js.html → 2.4.0/classes_SidechatColorList.js.html} +75 -12
  13. package/docs/sidechat.js/2.4.0/data/search.json +1 -0
  14. package/docs/sidechat.js/2.4.0/global.html +3 -0
  15. package/docs/sidechat.js/{2.2.0 → 2.4.0}/index.html +2 -2
  16. package/docs/sidechat.js/{2.0.4 → 2.4.0}/tutorial-Authentication.html +4 -3
  17. package/docs/sidechat.js/{2.0.4 → 2.4.0}/tutorial-Email Registration.html +2 -2
  18. package/docs/sidechat.js/{2.2.1 → 2.4.0}/types_SidechatTypes.js.html +2 -2
  19. package/package.json +1 -1
  20. package/src/classes/SidechatAPIClient.js +127 -90
  21. package/src/classes/SidechatColorList.js +5 -6
  22. package/src/tests/postTest.js +2 -1
  23. package/docs/sidechat.js/2.0.4/SidechatAPIClient.html +0 -3
  24. package/docs/sidechat.js/2.0.4/SidechatAPIError.html +0 -3
  25. package/docs/sidechat.js/2.0.4/classes_SidechatAPIClient.js.html +0 -425
  26. package/docs/sidechat.js/2.0.4/data/search.json +0 -1
  27. package/docs/sidechat.js/2.0.4/global.html +0 -3
  28. package/docs/sidechat.js/2.0.4/index.html +0 -4
  29. package/docs/sidechat.js/2.0.4/types_SidechatTypes.js.html +0 -98
  30. package/docs/sidechat.js/2.0.6/SidechatAPIClient.html +0 -3
  31. package/docs/sidechat.js/2.0.6/SidechatAPIError.html +0 -3
  32. package/docs/sidechat.js/2.0.6/classes_SidechatAPIClient.js.html +0 -462
  33. package/docs/sidechat.js/2.0.6/data/search.json +0 -1
  34. package/docs/sidechat.js/2.0.6/fonts/Inconsolata-Regular.ttf +0 -0
  35. package/docs/sidechat.js/2.0.6/fonts/OpenSans-Regular.ttf +0 -0
  36. package/docs/sidechat.js/2.0.6/fonts/WorkSans-Bold.ttf +0 -0
  37. package/docs/sidechat.js/2.0.6/global.html +0 -3
  38. package/docs/sidechat.js/2.0.6/index.html +0 -4
  39. package/docs/sidechat.js/2.0.6/scripts/core.js +0 -702
  40. package/docs/sidechat.js/2.0.6/scripts/core.min.js +0 -23
  41. package/docs/sidechat.js/2.0.6/scripts/resize.js +0 -90
  42. package/docs/sidechat.js/2.0.6/scripts/search.js +0 -265
  43. package/docs/sidechat.js/2.0.6/scripts/search.min.js +0 -6
  44. package/docs/sidechat.js/2.0.6/scripts/third-party/Apache-License-2.0.txt +0 -202
  45. package/docs/sidechat.js/2.0.6/scripts/third-party/fuse.js +0 -9
  46. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-line-num-original.js +0 -369
  47. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-line-num.js +0 -1
  48. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-original.js +0 -5171
  49. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs.js +0 -1
  50. package/docs/sidechat.js/2.0.6/scripts/third-party/popper.js +0 -5
  51. package/docs/sidechat.js/2.0.6/scripts/third-party/tippy.js +0 -1
  52. package/docs/sidechat.js/2.0.6/scripts/third-party/tocbot.js +0 -672
  53. package/docs/sidechat.js/2.0.6/scripts/third-party/tocbot.min.js +0 -1
  54. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-base.css +0 -975
  55. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-dark.css +0 -407
  56. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-light.css +0 -388
  57. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme.min.css +0 -1
  58. package/docs/sidechat.js/2.0.6/tutorial-Authentication.html +0 -13
  59. package/docs/sidechat.js/2.0.6/tutorial-Email Registration.html +0 -6
  60. package/docs/sidechat.js/2.0.6/types_SidechatTypes.js.html +0 -114
  61. package/docs/sidechat.js/2.1.0/SidechatAPIClient.html +0 -3
  62. package/docs/sidechat.js/2.1.0/SidechatAPIError.html +0 -3
  63. package/docs/sidechat.js/2.1.0/classes_SidechatAPIClient.js.html +0 -528
  64. package/docs/sidechat.js/2.1.0/classes_SidechatAPIError.js.html +0 -16
  65. package/docs/sidechat.js/2.1.0/data/search.json +0 -1
  66. package/docs/sidechat.js/2.1.0/fonts/Inconsolata-Regular.ttf +0 -0
  67. package/docs/sidechat.js/2.1.0/fonts/OpenSans-Regular.ttf +0 -0
  68. package/docs/sidechat.js/2.1.0/fonts/WorkSans-Bold.ttf +0 -0
  69. package/docs/sidechat.js/2.1.0/global.html +0 -3
  70. package/docs/sidechat.js/2.1.0/index.html +0 -4
  71. package/docs/sidechat.js/2.1.0/scripts/core.js +0 -702
  72. package/docs/sidechat.js/2.1.0/scripts/core.min.js +0 -23
  73. package/docs/sidechat.js/2.1.0/scripts/resize.js +0 -90
  74. package/docs/sidechat.js/2.1.0/scripts/search.js +0 -265
  75. package/docs/sidechat.js/2.1.0/scripts/search.min.js +0 -6
  76. package/docs/sidechat.js/2.1.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  77. package/docs/sidechat.js/2.1.0/scripts/third-party/fuse.js +0 -9
  78. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-line-num-original.js +0 -369
  79. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-line-num.js +0 -1
  80. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs-original.js +0 -5171
  81. package/docs/sidechat.js/2.1.0/scripts/third-party/hljs.js +0 -1
  82. package/docs/sidechat.js/2.1.0/scripts/third-party/popper.js +0 -5
  83. package/docs/sidechat.js/2.1.0/scripts/third-party/tippy.js +0 -1
  84. package/docs/sidechat.js/2.1.0/scripts/third-party/tocbot.js +0 -672
  85. package/docs/sidechat.js/2.1.0/scripts/third-party/tocbot.min.js +0 -1
  86. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-base.css +0 -975
  87. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-dark.css +0 -407
  88. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme-light.css +0 -388
  89. package/docs/sidechat.js/2.1.0/styles/clean-jsdoc-theme.min.css +0 -1
  90. package/docs/sidechat.js/2.1.0/tutorial-Authentication.html +0 -13
  91. package/docs/sidechat.js/2.1.0/tutorial-Email Registration.html +0 -6
  92. package/docs/sidechat.js/2.1.0/types_SidechatTypes.js.html +0 -134
  93. package/docs/sidechat.js/2.2.0/SidechatAPIClient.html +0 -3
  94. package/docs/sidechat.js/2.2.0/SidechatAPIError.html +0 -3
  95. package/docs/sidechat.js/2.2.0/classes_SidechatAPIClient.js.html +0 -651
  96. package/docs/sidechat.js/2.2.0/data/search.json +0 -1
  97. package/docs/sidechat.js/2.2.0/fonts/Inconsolata-Regular.ttf +0 -0
  98. package/docs/sidechat.js/2.2.0/fonts/OpenSans-Regular.ttf +0 -0
  99. package/docs/sidechat.js/2.2.0/fonts/WorkSans-Bold.ttf +0 -0
  100. package/docs/sidechat.js/2.2.0/global.html +0 -3
  101. package/docs/sidechat.js/2.2.0/scripts/core.js +0 -702
  102. package/docs/sidechat.js/2.2.0/scripts/core.min.js +0 -23
  103. package/docs/sidechat.js/2.2.0/scripts/resize.js +0 -90
  104. package/docs/sidechat.js/2.2.0/scripts/search.js +0 -265
  105. package/docs/sidechat.js/2.2.0/scripts/search.min.js +0 -6
  106. package/docs/sidechat.js/2.2.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  107. package/docs/sidechat.js/2.2.0/scripts/third-party/fuse.js +0 -9
  108. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-line-num-original.js +0 -369
  109. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-line-num.js +0 -1
  110. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs-original.js +0 -5171
  111. package/docs/sidechat.js/2.2.0/scripts/third-party/hljs.js +0 -1
  112. package/docs/sidechat.js/2.2.0/scripts/third-party/popper.js +0 -5
  113. package/docs/sidechat.js/2.2.0/scripts/third-party/tippy.js +0 -1
  114. package/docs/sidechat.js/2.2.0/scripts/third-party/tocbot.js +0 -672
  115. package/docs/sidechat.js/2.2.0/scripts/third-party/tocbot.min.js +0 -1
  116. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-base.css +0 -975
  117. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-dark.css +0 -407
  118. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme-light.css +0 -388
  119. package/docs/sidechat.js/2.2.0/styles/clean-jsdoc-theme.min.css +0 -1
  120. package/docs/sidechat.js/2.2.0/tutorial-Authentication.html +0 -14
  121. package/docs/sidechat.js/2.2.0/tutorial-Email Registration.html +0 -6
  122. package/docs/sidechat.js/2.2.0/types_SidechatTypes.js.html +0 -134
  123. package/docs/sidechat.js/2.2.1/SidechatAPIClient.html +0 -3
  124. package/docs/sidechat.js/2.2.1/SidechatAPIError.html +0 -3
  125. package/docs/sidechat.js/2.2.1/classes_SidechatAPIClient.js.html +0 -688
  126. package/docs/sidechat.js/2.2.1/classes_SidechatAPIError.js.html +0 -16
  127. package/docs/sidechat.js/2.2.1/data/search.json +0 -1
  128. package/docs/sidechat.js/2.2.1/fonts/Inconsolata-Regular.ttf +0 -0
  129. package/docs/sidechat.js/2.2.1/fonts/OpenSans-Regular.ttf +0 -0
  130. package/docs/sidechat.js/2.2.1/fonts/WorkSans-Bold.ttf +0 -0
  131. package/docs/sidechat.js/2.2.1/global.html +0 -3
  132. package/docs/sidechat.js/2.2.1/index.html +0 -4
  133. package/docs/sidechat.js/2.2.1/scripts/core.js +0 -702
  134. package/docs/sidechat.js/2.2.1/scripts/core.min.js +0 -23
  135. package/docs/sidechat.js/2.2.1/scripts/resize.js +0 -90
  136. package/docs/sidechat.js/2.2.1/scripts/search.js +0 -265
  137. package/docs/sidechat.js/2.2.1/scripts/search.min.js +0 -6
  138. package/docs/sidechat.js/2.2.1/scripts/third-party/Apache-License-2.0.txt +0 -202
  139. package/docs/sidechat.js/2.2.1/scripts/third-party/fuse.js +0 -9
  140. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-line-num-original.js +0 -369
  141. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-line-num.js +0 -1
  142. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-original.js +0 -5171
  143. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs.js +0 -1
  144. package/docs/sidechat.js/2.2.1/scripts/third-party/popper.js +0 -5
  145. package/docs/sidechat.js/2.2.1/scripts/third-party/tippy.js +0 -1
  146. package/docs/sidechat.js/2.2.1/scripts/third-party/tocbot.js +0 -672
  147. package/docs/sidechat.js/2.2.1/scripts/third-party/tocbot.min.js +0 -1
  148. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-base.css +0 -975
  149. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-dark.css +0 -407
  150. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-light.css +0 -388
  151. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme.min.css +0 -1
  152. package/docs/sidechat.js/2.2.1/tutorial-Authentication.html +0 -14
  153. package/docs/sidechat.js/2.2.1/tutorial-Email Registration.html +0 -6
  154. package/docs/sidechat.js/2.2.3/SidechatAPIClient.html +0 -3
  155. package/docs/sidechat.js/2.2.3/SidechatAPIError.html +0 -3
  156. package/docs/sidechat.js/2.2.3/classes_SidechatAPIClient.js.html +0 -689
  157. package/docs/sidechat.js/2.2.3/classes_SidechatAPIError.js.html +0 -16
  158. package/docs/sidechat.js/2.2.3/data/search.json +0 -1
  159. package/docs/sidechat.js/2.2.3/fonts/Inconsolata-Regular.ttf +0 -0
  160. package/docs/sidechat.js/2.2.3/fonts/OpenSans-Regular.ttf +0 -0
  161. package/docs/sidechat.js/2.2.3/fonts/WorkSans-Bold.ttf +0 -0
  162. package/docs/sidechat.js/2.2.3/global.html +0 -3
  163. package/docs/sidechat.js/2.2.3/index.html +0 -4
  164. package/docs/sidechat.js/2.2.3/scripts/core.js +0 -702
  165. package/docs/sidechat.js/2.2.3/scripts/core.min.js +0 -23
  166. package/docs/sidechat.js/2.2.3/scripts/resize.js +0 -90
  167. package/docs/sidechat.js/2.2.3/scripts/search.js +0 -265
  168. package/docs/sidechat.js/2.2.3/scripts/search.min.js +0 -6
  169. package/docs/sidechat.js/2.2.3/scripts/third-party/Apache-License-2.0.txt +0 -202
  170. package/docs/sidechat.js/2.2.3/scripts/third-party/fuse.js +0 -9
  171. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-line-num-original.js +0 -369
  172. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-line-num.js +0 -1
  173. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs-original.js +0 -5171
  174. package/docs/sidechat.js/2.2.3/scripts/third-party/hljs.js +0 -1
  175. package/docs/sidechat.js/2.2.3/scripts/third-party/popper.js +0 -5
  176. package/docs/sidechat.js/2.2.3/scripts/third-party/tippy.js +0 -1
  177. package/docs/sidechat.js/2.2.3/scripts/third-party/tocbot.js +0 -672
  178. package/docs/sidechat.js/2.2.3/scripts/third-party/tocbot.min.js +0 -1
  179. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-base.css +0 -975
  180. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-dark.css +0 -407
  181. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme-light.css +0 -388
  182. package/docs/sidechat.js/2.2.3/styles/clean-jsdoc-theme.min.css +0 -1
  183. package/docs/sidechat.js/2.2.3/tutorial-Authentication.html +0 -14
  184. package/docs/sidechat.js/2.2.3/tutorial-Email Registration.html +0 -6
  185. package/docs/sidechat.js/2.2.3/types_SidechatTypes.js.html +0 -134
  186. package/docs/sidechat.js/2.3.0/SidechatAPIClient.html +0 -3
  187. package/docs/sidechat.js/2.3.0/SidechatAPIError.html +0 -3
  188. package/docs/sidechat.js/2.3.0/classes_SidechatAPIClient.js.html +0 -720
  189. package/docs/sidechat.js/2.3.0/classes_SidechatAPIError.js.html +0 -16
  190. package/docs/sidechat.js/2.3.0/data/search.json +0 -1
  191. package/docs/sidechat.js/2.3.0/fonts/Inconsolata-Regular.ttf +0 -0
  192. package/docs/sidechat.js/2.3.0/fonts/OpenSans-Regular.ttf +0 -0
  193. package/docs/sidechat.js/2.3.0/fonts/WorkSans-Bold.ttf +0 -0
  194. package/docs/sidechat.js/2.3.0/global.html +0 -3
  195. package/docs/sidechat.js/2.3.0/index.html +0 -4
  196. package/docs/sidechat.js/2.3.0/scripts/core.js +0 -702
  197. package/docs/sidechat.js/2.3.0/scripts/core.min.js +0 -23
  198. package/docs/sidechat.js/2.3.0/scripts/resize.js +0 -90
  199. package/docs/sidechat.js/2.3.0/scripts/search.js +0 -265
  200. package/docs/sidechat.js/2.3.0/scripts/search.min.js +0 -6
  201. package/docs/sidechat.js/2.3.0/scripts/third-party/Apache-License-2.0.txt +0 -202
  202. package/docs/sidechat.js/2.3.0/scripts/third-party/fuse.js +0 -9
  203. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-line-num-original.js +0 -369
  204. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-line-num.js +0 -1
  205. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs-original.js +0 -5171
  206. package/docs/sidechat.js/2.3.0/scripts/third-party/hljs.js +0 -1
  207. package/docs/sidechat.js/2.3.0/scripts/third-party/popper.js +0 -5
  208. package/docs/sidechat.js/2.3.0/scripts/third-party/tippy.js +0 -1
  209. package/docs/sidechat.js/2.3.0/scripts/third-party/tocbot.js +0 -672
  210. package/docs/sidechat.js/2.3.0/scripts/third-party/tocbot.min.js +0 -1
  211. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-base.css +0 -975
  212. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-dark.css +0 -407
  213. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme-light.css +0 -388
  214. package/docs/sidechat.js/2.3.0/styles/clean-jsdoc-theme.min.css +0 -1
  215. package/docs/sidechat.js/2.3.0/tutorial-Authentication.html +0 -14
  216. package/docs/sidechat.js/2.3.0/tutorial-Email Registration.html +0 -6
  217. package/docs/sidechat.js/2.3.0/types_SidechatTypes.js.html +0 -134
  218. package/docs/sidechat.js/2.3.1/SidechatAPIClient.html +0 -3
  219. package/docs/sidechat.js/2.3.1/SidechatAPIError.html +0 -3
  220. package/docs/sidechat.js/2.3.1/classes_SidechatAPIError.js.html +0 -16
  221. package/docs/sidechat.js/2.3.1/data/search.json +0 -1
  222. package/docs/sidechat.js/2.3.1/fonts/Inconsolata-Regular.ttf +0 -0
  223. package/docs/sidechat.js/2.3.1/fonts/OpenSans-Regular.ttf +0 -0
  224. package/docs/sidechat.js/2.3.1/fonts/WorkSans-Bold.ttf +0 -0
  225. package/docs/sidechat.js/2.3.1/global.html +0 -3
  226. package/docs/sidechat.js/2.3.1/index.html +0 -4
  227. package/docs/sidechat.js/2.3.1/scripts/core.js +0 -702
  228. package/docs/sidechat.js/2.3.1/scripts/core.min.js +0 -23
  229. package/docs/sidechat.js/2.3.1/scripts/resize.js +0 -90
  230. package/docs/sidechat.js/2.3.1/scripts/search.js +0 -265
  231. package/docs/sidechat.js/2.3.1/scripts/search.min.js +0 -6
  232. package/docs/sidechat.js/2.3.1/scripts/third-party/Apache-License-2.0.txt +0 -202
  233. package/docs/sidechat.js/2.3.1/scripts/third-party/fuse.js +0 -9
  234. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-line-num-original.js +0 -369
  235. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-line-num.js +0 -1
  236. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs-original.js +0 -5171
  237. package/docs/sidechat.js/2.3.1/scripts/third-party/hljs.js +0 -1
  238. package/docs/sidechat.js/2.3.1/scripts/third-party/popper.js +0 -5
  239. package/docs/sidechat.js/2.3.1/scripts/third-party/tippy.js +0 -1
  240. package/docs/sidechat.js/2.3.1/scripts/third-party/tocbot.js +0 -672
  241. package/docs/sidechat.js/2.3.1/scripts/third-party/tocbot.min.js +0 -1
  242. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-base.css +0 -975
  243. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-dark.css +0 -407
  244. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme-light.css +0 -388
  245. package/docs/sidechat.js/2.3.1/styles/clean-jsdoc-theme.min.css +0 -1
  246. package/docs/sidechat.js/2.3.1/tutorial-Authentication.html +0 -14
  247. package/docs/sidechat.js/2.3.1/tutorial-Email Registration.html +0 -6
  248. package/docs/sidechat.js/2.3.1/types_SidechatTypes.js.html +0 -134
  249. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/fonts/Inconsolata-Regular.ttf +0 -0
  250. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/fonts/OpenSans-Regular.ttf +0 -0
  251. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/fonts/WorkSans-Bold.ttf +0 -0
  252. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/core.js +0 -0
  253. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/core.min.js +0 -0
  254. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/resize.js +0 -0
  255. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/search.js +0 -0
  256. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/search.min.js +0 -0
  257. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/Apache-License-2.0.txt +0 -0
  258. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/fuse.js +0 -0
  259. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/hljs-line-num-original.js +0 -0
  260. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/hljs-line-num.js +0 -0
  261. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/hljs-original.js +0 -0
  262. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/hljs.js +0 -0
  263. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/popper.js +0 -0
  264. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/tippy.js +0 -0
  265. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/tocbot.js +0 -0
  266. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/scripts/third-party/tocbot.min.js +0 -0
  267. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/styles/clean-jsdoc-theme-base.css +0 -0
  268. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/styles/clean-jsdoc-theme-dark.css +0 -0
  269. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/styles/clean-jsdoc-theme-light.css +0 -0
  270. /package/docs/sidechat.js/{2.0.4 → 2.4.0}/styles/clean-jsdoc-theme.min.css +0 -0
package/docs/sidechat.js/2.0.4/types_SidechatTypes.js.html DELETED
@@ -1,98 +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: types/SidechatTypes.js</title><!--[if lt IE 9]>
2
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
- <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAsset">SidechatAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">types_SidechatTypes.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
4
- * A user-created post or comment, depending on the "type" prop
5
- * @typedef {Object} SidechatPostOrComment
6
- * @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
7
- * @prop {String} id - alphanumeric ID of post or comment
8
- * @prop {Boolean} authored_by_user - undocumented
9
- * @prop {String} alias - post creator's name in-app
10
- * @prop {String} group_id - alphanumeric ID of group
11
- * @prop {SidechatGroup} group - group in which post or comment was created
12
- * @prop {String} text - text content of post or comment
13
- * @prop {String} created_at - date string of post or comment creation time
14
- * @prop {Number} vote_total - sum of upvotes and downvotes
15
- * @prop {SidechatVoteString} vote_status - current user's vote on post or comment
16
- * @prop {SidechatAsset[]} assets - array of assets attached to post or comment
17
- * @prop {Array} attachments - undocumented
18
- * @prop {Boolean} dms_disabled - whether or not you can send a DM to creator of post
19
- * @prop {Array} tags - undocumented
20
- * @prop {SidechatIdentity} identity - creator's identity information
21
- * @prop {Boolean} pinned - undocumented
22
- * @prop {Boolean} is_saved - undocumented
23
- * @prop {"following"|"not_following"} follow_status - undocumented
24
- * @prop {"group"} [destination] - undocumented
25
- * @prop {Number} [comment_count] - number of comments on post (only if type=post)
26
- * @prop {Boolean} [comments_disabled] - whether or not you can comment on post (only if type=post)
27
- * @prop {String} [parent_post_id] - alphanumeric ID of parent post (only if type=comment)
28
- * @prop {String} [reply_post_id] - alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
29
- * @prop {String} [context] - text content of comment being replied to, falls back to text (only if type=comment)
30
- */
31
-
32
- /**
33
- * A group object, containing metadata about a group as well as its join conditions and states
34
- * @typedef {Object} SidechatGroup
35
- * @prop {String} id - alphanumeric ID of group
36
- * @prop {String} name - human-readable name of group
37
- * @prop {String} analytics_name - name to file group under
38
- * @prop {"non_member"|"member"} membership_type - whether or not current user is a member of group
39
- * @prop {String} color - group's theme color as hex code (e.g., #FFFFFF)
40
- * @prop {"open"|"closed"|"email_domain"} group_join_type - basis on which group accepts new members
41
- * @prop {"private"|"public_to_all"|"public_to_schools"} group_visibility - group's visibility setting
42
- * @prop {"show"|"hide"} asset_library_visibility - whether or not group's asset library is visible
43
- * @prop {Array} [roles] - undocumented
44
- * @prop {String} [description] - description of group
45
- * @prop {SidechatPrivateAssetURL} [icon_url] - image URL for group icon
46
- * @prop {Number} [member_count] - number of users in group
47
- * @prop {Boolean} [should_show_leaderboard] - undocumented
48
- */
49
-
50
- /**
51
- * An asset object, containing information about an image within a post or comment
52
- * @typedef {Object} SidechatAsset
53
- * @prop {String} id - alphanumeric ID of asset
54
- * @prop {"image"} type - undocumented
55
- * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
56
- * @prop {Number} width - the width of asset
57
- * @prop {Number} height - the height of asset
58
- * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
59
- */
60
-
61
- /**
62
- * A user's identity information
63
- * @typedef {Object} SidechatIdentity
64
- * @prop {String} name - representation of user's name (varies across app)
65
- * @prop {Boolean} posted_with_username - undocumented
66
- */
67
-
68
- /**
69
- * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
70
- * @typedef {String} SidechatPrivateAssetURL
71
- */
72
-
73
- /**
74
- * A cursor for paginating through post lists
75
- * @typedef {String} SidechatCursorString
76
- */
77
-
78
- /**
79
- * A vote on a comment or post
80
- * @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
81
- */
82
-
83
- /**
84
- * A user's bearer authentication token needed for most requests
85
- * @typedef {String} SidechatAuthToken
86
- */
87
-
88
- /**
89
- * A list of posts and the associated cursor
90
- * @typedef {Object} SidechatPostsAndCursor
91
- * @prop {SidechatPostOrComment[]} posts
92
- * @prop {SidechatCursorString} cursor
93
- */
94
-
95
- /**
96
- * @tutorial Hello world
97
- */
98
- </code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAsset">SidechatAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
package/docs/sidechat.js/2.0.6/SidechatAPIClient.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>Class: SidechatAPIClient</title><!--[if lt IE 9]>
2
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
- <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="SidechatAPIClient-title" class="has-anchor">SidechatAPIClient</h1><div class="class-description"><p>API client class for making requests to Sidechat's private API. You'll need to <a href="tutorial-Authentication.html">authenticate</a> before using most of the methods.</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="SidechatAPIClient"><span class="type-signature"></span>new SidechatAPIClient<span class="signature">(token<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Create a new instance of the API client</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>token</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>user bearer token</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>2.0.0-alpha.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line9">line 9</a></li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="defaultHeaders"><span class="type-signature"></span>defaultHeaders<span class="type-signature"> :Object</span></h3><div class="description"><p>Default headers for every API request</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</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="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line20">line 20</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="userToken"><span class="type-signature"></span>userToken<span class="type-signature"> :<a href="global.html#SidechatAuthToken">SidechatAuthToken</a></span></h3><div class="description"><p>User bearer token</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></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="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line14">line 14</a></li></ul></dd></div></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="checkEmailVerification"><span class="type-signature"></span>checkEmailVerification<span class="signature">()</span></h3><div class="description"><p>Check is the user's email is verified.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>1.0.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line174">line 174</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="getAssetLibrary"><span class="type-signature"></span>getAssetLibrary<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a>>}</span></h3><div class="description"><p>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.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>2.0.6</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line438">line 438</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Array.&lt;<a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a>></span></dd></dl></div><h3 class="name has-anchor" id="getAvailableGroups"><span class="type-signature"></span>getAvailableGroups<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#SidechatGroup">SidechatGroup</a>>}</span></h3><div class="description"><p>Gets groups to be displayed on the &quot;Explore Groups&quot; page</p></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>2.0.0-alpha.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line412">line 412</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Array.&lt;<a href="global.html#SidechatGroup">SidechatGroup</a>></span></dd></dl></div><h3 class="name has-anchor" id="getGroupPosts"><span class="type-signature"></span>getGroupPosts<span class="signature">(groupID, category, cursor<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a>}</span></h3><div class="description"><p>Fetches posts from the specified category in a group</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</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="attributes"></td><td class="description last"><p>group ID</p></td></tr><tr><td class="name"><code>category</code></td><td class="type"><span class="param-type">"hot"</span> |<wbr> <span class="param-type">"recent"</span> |<wbr> <span class="param-type">"top"</span></td><td class="attributes"></td><td class="description last"><p>category to filter posts</p></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="attributes">&lt;optional><br></td><td class="description last"><p>cursor string</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>1.0.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line274">line 274</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>List of posts and cursor</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></span></dd></dl></div><h3 class="name has-anchor" id="getPostComments"><span class="type-signature"></span>getPostComments<span class="signature">(postID)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a>>}</span></h3><div class="description"><p>Get all the commments on a post</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>postID</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>post ID to get comments for</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>2.0.0-alpha.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line337">line 337</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>list of comments</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Array.&lt;<a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a>></span></dd></dl></div><h3 class="name has-anchor" id="getUserAndGroup"><span class="type-signature"></span>getUserAndGroup<span class="signature">(groupID<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Get updated status for user and group</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</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="attributes">&lt;optional><br></td><td class="description last"><p>ID of a specific group to retrieve info from</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>1.0.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line242">line 242</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="loginViaSMS"><span class="type-signature"></span>loginViaSMS<span class="signature">(phoneNumber)</span></h3><div class="description"><p>Initiate the login process with a phone number. Should be followed up with verifySMSCode().</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>phoneNumber</code></td><td class="type"><span class="param-type">Number</span></td><td class="description last"><p>US phone number (WITHOUT +1) to send verification code to</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>1.0.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line50">line 50</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="registerEmail"><span class="type-signature"></span>registerEmail<span class="signature">(email)</span></h3><div class="description"><p>Initiate the email setup process. Should be followed up with checkEmailVerification().</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>email</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>school email address to send verification code to</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>1.0.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line140">line 140</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-tutorial bold">Tutorials</dt><dd class="tag-tutorial"><ul><li><a href="tutorial-Email Registration.html">Email Registration</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="setAge"><span class="type-signature"></span>setAge<span class="signature">(age, registrationID)</span></h3><div class="description"><p>Set the user's age. If this function succeeds, the user will be authenticated for future requests.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>age</code></td><td class="type"><span class="param-type">Number</span></td><td class="description last"><p>user's age in years</p></td></tr><tr><td class="name"><code>registrationID</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>the registration ID generated by verifySMSCode()</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>1.0.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line106">line 106</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="setDeviceID"><span class="type-signature"></span>setDeviceID<span class="signature">(deviceId)</span></h3><div class="description"><p>Set the device ID of the current user</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>deviceId</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>the device ID to set</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>1.0.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line207">line 207</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="setToken"><span class="type-signature"></span>setToken<span class="signature">(token)</span></h3><div class="description"><p>Manually set the currently signed in user's token. Generally try to avoid this and instead either pass a token to the constructor or login automatically through the auth functions</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>token</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></span></td><td class="description last"><p>user bearer token</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="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line40">line 40</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="setVote"><span class="type-signature"></span>setVote<span class="signature">(postID, action)</span></h3><div class="description"><p>Upvote or downvote, or unvote a post</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>postID</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>post ID to vote on</p></td></tr><tr><td class="name"><code>action</code></td><td class="type"><span class="param-type"><a href="global.html#SidechatVoteString">SidechatVoteString</a></span></td><td class="description last"><p>whether to upvote, downvote, or reset vote</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>2.0.0-alpha.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line306">line 306</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="verifySMSCode"><span class="type-signature"></span>verifySMSCode<span class="signature">(phoneNumber, code)</span></h3><div class="description"><p>Verify the code sent via SMS with loginViaSMS(). If this function succeeds, the user will be authenticated for future requests.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>phoneNumber</code></td><td class="type"><span class="param-type">Number</span></td><td class="description last"><p>US phone number (WITHOUT +1) that verification code was sent to</p></td></tr><tr><td class="name"><code>code</code></td><td class="type"><span class="param-type">String</span></td><td class="description last"><p>the verification code</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-since bold">Since</dt><dd class="tag-since"><ul><li>1.0.0</li></ul></dd></div><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIClient.js.html">classes/SidechatAPIClient.js</a>, <a href="classes_SidechatAPIClient.js.html#line75">line 75</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#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
package/docs/sidechat.js/2.0.6/SidechatAPIError.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>Class: SidechatAPIError</title><!--[if lt IE 9]>
2
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
- <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="SidechatAPIError-title" class="has-anchor">SidechatAPIError</h1><div class="class-description"><p>Throwable error caused by the Sidechat API</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="SidechatAPIError"><span class="type-signature"></span>new SidechatAPIError<span class="signature">()</span></h3><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="classes_SidechatAPIError.js.html">classes/SidechatAPIError.js</a>, <a href="classes_SidechatAPIError.js.html#line6">line 6</a></li></ul></dd></div></dl></div><h2 id="Extends" class="subsection-title has-anchor">Extends</h2><ul><li>Error</li></ul></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>