sidechat.js 2.4.8 → 2.4.9

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 (42) hide show
  1. package/dist/classes/SidechatAPIClient.d.ts +11 -0
  2. package/dist/classes/SidechatAPIClient.d.ts.map +1 -1
  3. package/dist/index.cjs +31 -0
  4. package/dist/index.mjs +29 -0
  5. package/docs/sidechat.js/2.4.9/SidechatAPIClient.html +3 -0
  6. package/docs/sidechat.js/2.4.9/SidechatAPIError.html +3 -0
  7. package/docs/sidechat.js/2.4.9/SidechatColorList.html +3 -0
  8. package/docs/sidechat.js/2.4.9/classes_SidechatAPIClient.js.html +1128 -0
  9. package/docs/sidechat.js/2.4.9/classes_SidechatAPIError.js.html +16 -0
  10. package/docs/sidechat.js/2.4.9/classes_SidechatColorList.js.html +79 -0
  11. package/docs/sidechat.js/2.4.9/data/search.json +1 -0
  12. package/docs/sidechat.js/2.4.9/fonts/Inconsolata-Regular.ttf +0 -0
  13. package/docs/sidechat.js/2.4.9/fonts/OpenSans-Regular.ttf +0 -0
  14. package/docs/sidechat.js/2.4.9/fonts/WorkSans-Bold.ttf +0 -0
  15. package/docs/sidechat.js/2.4.9/global.html +3 -0
  16. package/docs/sidechat.js/2.4.9/index.html +4 -0
  17. package/docs/sidechat.js/2.4.9/scripts/core.js +726 -0
  18. package/docs/sidechat.js/2.4.9/scripts/core.min.js +23 -0
  19. package/docs/sidechat.js/2.4.9/scripts/resize.js +90 -0
  20. package/docs/sidechat.js/2.4.9/scripts/search.js +265 -0
  21. package/docs/sidechat.js/2.4.9/scripts/search.min.js +6 -0
  22. package/docs/sidechat.js/2.4.9/scripts/third-party/Apache-License-2.0.txt +202 -0
  23. package/docs/sidechat.js/2.4.9/scripts/third-party/fuse.js +9 -0
  24. package/docs/sidechat.js/2.4.9/scripts/third-party/hljs-line-num-original.js +369 -0
  25. package/docs/sidechat.js/2.4.9/scripts/third-party/hljs-line-num.js +1 -0
  26. package/docs/sidechat.js/2.4.9/scripts/third-party/hljs-original.js +5171 -0
  27. package/docs/sidechat.js/2.4.9/scripts/third-party/hljs.js +1 -0
  28. package/docs/sidechat.js/2.4.9/scripts/third-party/popper.js +5 -0
  29. package/docs/sidechat.js/2.4.9/scripts/third-party/tippy.js +1 -0
  30. package/docs/sidechat.js/2.4.9/scripts/third-party/tocbot.js +672 -0
  31. package/docs/sidechat.js/2.4.9/scripts/third-party/tocbot.min.js +1 -0
  32. package/docs/sidechat.js/2.4.9/styles/clean-jsdoc-theme-base.css +1159 -0
  33. package/docs/sidechat.js/2.4.9/styles/clean-jsdoc-theme-dark.css +412 -0
  34. package/docs/sidechat.js/2.4.9/styles/clean-jsdoc-theme-light.css +482 -0
  35. package/docs/sidechat.js/2.4.9/styles/clean-jsdoc-theme-scrollbar.css +30 -0
  36. package/docs/sidechat.js/2.4.9/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
  37. package/docs/sidechat.js/2.4.9/styles/clean-jsdoc-theme.min.css +1 -0
  38. package/docs/sidechat.js/2.4.9/tutorial-Authentication.html +14 -0
  39. package/docs/sidechat.js/2.4.9/tutorial-Email Registration.html +6 -0
  40. package/docs/sidechat.js/2.4.9/types_SidechatTypes.js.html +160 -0
  41. package/package.json +2 -2
  42. package/src/classes/SidechatAPIClient.js +29 -0
@@ -0,0 +1,1128 @@
1
+ <!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: classes/SidechatAPIClient.js</title><!--[if lt IE 9]>
2
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
+ <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><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 class="sidebar-section-children"><a href="SidechatColorList.html">SidechatColorList</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#SidechatColor">SidechatColor</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#SidechatDirectMessage">SidechatDirectMessage</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectThread">SidechatDirectThread</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://offsides.micahlindley.com" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">classes_SidechatAPIClient.js</h1></header><article><pre class="prettyprint source lang-js"><code>import "../types/SidechatTypes.js";
4
+ import SidechatAPIError from "../classes/SidechatAPIError.js";
5
+
6
+ /**
7
+ * API client class for making requests to Sidechat's private API. You'll need to [authenticate]{@tutorial Authentication} before using most of the methods.
8
+ * @class
9
+ * @since 2.0.0-alpha.0
10
+ */
11
+ class SidechatAPIClient {
12
+ /**
13
+ * User bearer token
14
+ * @type {SidechatAuthToken}
15
+ * */
16
+ userToken;
17
+
18
+ /**
19
+ * Default headers for every API request
20
+ * @type {Object}
21
+ * @static
22
+ * @constant
23
+ */
24
+ defaultHeaders = {
25
+ Accept: "application/json",
26
+ "Content-Type": "application/json",
27
+ "App-Version": "6.0.0",
28
+ Dnt: 1,
29
+ };
30
+
31
+ /**
32
+ * Root URL for every API request
33
+ * @type {String}
34
+ * @default "https://api.sidechat.lol"
35
+ */
36
+ apiRoot = "https://api.sidechat.lol";
37
+
38
+ /**
39
+ * Create a new instance of the API client
40
+ * @param {SidechatAuthToken} [token] - user bearer token
41
+ * @param {String} rootUrl - custom API root URL for mocking or using other server
42
+ */
43
+ constructor(token = "", rootUrl = "") {
44
+ if (token) {
45
+ this.userToken = token;
46
+ }
47
+ if (rootUrl) {
48
+ this.apiRoot = rootUrl;
49
+ }
50
+ }
51
+
52
+ /**
53
+ * 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
54
+ * @method
55
+ * @param {SidechatAuthToken} token - user bearer token
56
+ */
57
+ setToken = (token) => {
58
+ this.userToken = token;
59
+ };
60
+
61
+ /**
62
+ * Manually set the root URL for all API requests. This can be used for mocking requests or redirecting them to a different server
63
+ * @method
64
+ * @param {String} url - new root URL to set
65
+ * @since 2.3.9
66
+ */
67
+ setAPIRoot = (url) => {
68
+ this.apiRoot = url;
69
+ };
70
+
71
+ /**
72
+ * Run an arbitrary API request using the current client's authentication
73
+ * @method
74
+ * @param {String} endpoint - API endpoint to request (e.g. "/v1/posts")
75
+ * @param {"GET"|"POST"|"PUT"|"DELETE"|"PATCH"|"OPTIONS"} [method] - HTTP method to use
76
+ * @param {Object} [body] - body to send with the request
77
+ * @param {Object} [headers] - custom headers to send with the request
78
+ * @param {Boolean} [stripHeaders] - remove the default headers from the request
79
+ * @since 2.4.9
80
+ */
81
+ sendRequest = (
82
+ endpoint,
83
+ method = "GET",
84
+ body = undefined,
85
+ headers = {},
86
+ stripHeaders = false
87
+ ) => {
88
+ let requestHeaders = this.defaultHeaders;
89
+ if (stripHeaders) {
90
+ headers = {};
91
+ }
92
+ requestHeaders = { ...requestHeaders, ...headers };
93
+ return fetch(`${this.apiRoot}${endpoint}`, {
94
+ headers: { Authorization: `Bearer ${this.userToken}`, ...requestHeaders },
95
+ body: body,
96
+ method: method,
97
+ });
98
+ };
99
+
100
+ /**
101
+ * Initiate the login process with a phone number. Should be followed up with verifySMSCode().
102
+ * @method
103
+ * @since 1.0.0
104
+ * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
105
+ */
106
+ loginViaSMS = async (phoneNumber) => {
107
+ try {
108
+ const res = await fetch(`${this.apiRoot}/v1/login_register`, {
109
+ method: "POST",
110
+ headers: this.defaultHeaders,
111
+ body: JSON.stringify({
112
+ phone_number: `+1${phoneNumber}`,
113
+ version: 3,
114
+ }),
115
+ });
116
+ const json = await res.json();
117
+ return json;
118
+ } catch (err) {
119
+ console.error(err);
120
+ throw new SidechatAPIError("Failed to request SMS verification.");
121
+ }
122
+ };
123
+
124
+ /**
125
+ * Verify the code sent via SMS with loginViaSMS(). If this function succeeds, the user will be authenticated for future requests.
126
+ * @method
127
+ * @since 1.0.0
128
+ * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
129
+ * @param {String} code - the verification code
130
+ */
131
+ verifySMSCode = async (phoneNumber, code) => {
132
+ try {
133
+ const res = await fetch(`${this.apiRoot}/v1/verify_phone_number`, {
134
+ method: "POST",
135
+ headers: this.defaultHeaders,
136
+ body: JSON.stringify({
137
+ phone_number: `+1${phoneNumber}`,
138
+ code: code.toUpperCase(),
139
+ }),
140
+ });
141
+ const json = await res.json();
142
+ if (json?.logged_in_user?.token) {
143
+ this.userToken = json.logged_in_user.token;
144
+ }
145
+ return json;
146
+ } catch (err) {
147
+ console.error(err);
148
+ throw new SidechatAPIError("Failed verify this code.");
149
+ }
150
+ };
151
+
152
+ /**
153
+ * Set the user's age. If this function succeeds, the user will be authenticated for future requests.
154
+ * @method
155
+ * @since 1.0.0
156
+ * @param {Number} age - user's age in years
157
+ * @param {String} registrationID - the registration ID generated by verifySMSCode()
158
+ */
159
+ setAge = async (age, registrationID) => {
160
+ if (age &lt; 13) {
161
+ throw new SidechatAPIError("You're too young to use Offsides.");
162
+ }
163
+ try {
164
+ const res = await fetch(`${this.apiRoot}/v1/complete_registration`, {
165
+ method: "POST",
166
+ headers: this.defaultHeaders,
167
+ body: JSON.stringify({
168
+ age: Number(age),
169
+ registration_id: registrationID,
170
+ }),
171
+ });
172
+ const json = await res.json();
173
+ if (json.token) {
174
+ this.userToken = json.token;
175
+ }
176
+ return json;
177
+ } catch (err) {
178
+ console.error(err);
179
+ throw new SidechatAPIError("Failed verify this code.");
180
+ }
181
+ };
182
+
183
+ /**
184
+ * Initiate the email setup process. Should be followed up with checkEmailVerification().
185
+ * @method
186
+ * @since 1.0.0
187
+ * @param {String} email - school email address to send verification code to
188
+ * @tutorial Email Registration
189
+ */
190
+ registerEmail = async (email) => {
191
+ if (!this.userToken) {
192
+ throw new SidechatAPIError("User is not authenticated.");
193
+ }
194
+ try {
195
+ const res = await fetch(`${this.apiRoot}/v2/users/register_email`, {
196
+ method: "POST",
197
+ headers: {
198
+ ...this.defaultHeaders,
199
+ Authorization: `Bearer ${this.userToken}`,
200
+ },
201
+ body: JSON.stringify({
202
+ email: email,
203
+ }),
204
+ });
205
+ const json = await res.json();
206
+ if (json.message) {
207
+ throw new SidechatAPIError(json.message);
208
+ }
209
+ return json;
210
+ } catch (err) {
211
+ console.error(err);
212
+ throw new SidechatAPIError("Failed to request email verification.");
213
+ }
214
+ };
215
+
216
+ /**
217
+ * Check is the user's email is verified.
218
+ * @method
219
+ * @since 1.0.0
220
+ */
221
+ checkEmailVerification = async () => {
222
+ if (!this.userToken) {
223
+ throw new SidechatAPIError("User is not authenticated.");
224
+ }
225
+ try {
226
+ const res = await fetch(`${this.apiRoot}/v1/users/check_email_verified`, {
227
+ method: "GET",
228
+ headers: {
229
+ ...this.defaultHeaders,
230
+ Authorization: `Bearer ${this.userToken}`,
231
+ },
232
+ });
233
+ const json = await res.json();
234
+ if (json.verified_email_updates_response) {
235
+ return json.verified_email_updates_response;
236
+ } else {
237
+ throw new SidechatAPIError(json?.message || "Email is not verified.");
238
+ }
239
+ } catch (err) {
240
+ console.error(err);
241
+ throw new SidechatAPIError("Email is not verified.");
242
+ }
243
+ };
244
+
245
+ /**
246
+ * Set the device ID of the current user
247
+ * @method
248
+ * @since 1.0.0
249
+ * @param {String} deviceId - the device ID to set
250
+ */
251
+ setDeviceID = async (deviceID) => {
252
+ if (!this.userToken) {
253
+ throw new SidechatAPIError("User is not authenticated.");
254
+ }
255
+ try {
256
+ const res = await fetch(`${this.apiRoot}/v1/register_device_token`, {
257
+ method: "POST",
258
+ headers: {
259
+ ...this.defaultHeaders,
260
+ Authorization: `Bearer ${this.userToken}`,
261
+ },
262
+ body: JSON.stringify({
263
+ build_type: "release",
264
+ bundle_id: "com.flowerave.sidechat",
265
+ device_token: deviceID,
266
+ }),
267
+ });
268
+ const json = await res.json();
269
+ return json;
270
+ } catch (err) {
271
+ console.error(err);
272
+ throw new SidechatAPIError("Failed verify this code.");
273
+ }
274
+ };
275
+
276
+ /**
277
+ * Get updated status for user and group
278
+ * @method
279
+ * @since 1.0.0
280
+ * @deprecated since 2.1.0, will be removed by 3.0.0. Please use `getUpdates` instead!
281
+ * @param {String} [groupID] - ID of a specific group to retrieve info from. Falls back to user's primary group.
282
+ */
283
+ getUserAndGroup = async (groupID = "") => {
284
+ const json = await this.getUpdates(groupID);
285
+ return json;
286
+ };
287
+
288
+ /**
289
+ * Get updated status for user and group
290
+ * @method
291
+ * @since 2.1.0
292
+ * @param {String} [groupID] - ID of a specific group to retrieve info from. Falls back to user's primary group.
293
+ */
294
+ getUpdates = async (groupID = "") => {
295
+ if (!this.userToken) {
296
+ throw new SidechatAPIError("User is not authenticated.");
297
+ }
298
+ try {
299
+ const res = await fetch(
300
+ `${this.apiRoot}/v1/updates?group_id=${groupID}`,
301
+ {
302
+ method: "GET",
303
+ headers: {
304
+ ...this.defaultHeaders,
305
+ Authorization: `Bearer ${this.userToken}`,
306
+ },
307
+ }
308
+ );
309
+ const json = await res.json();
310
+ return json;
311
+ } catch (err) {
312
+ console.error(err);
313
+ throw new SidechatAPIError(`Failed to get posts from group.`);
314
+ }
315
+ };
316
+
317
+ /**
318
+ * Fetches posts from the specified category in a group
319
+ * @method
320
+ * @since 1.0.0
321
+ * @param {String} groupID - group ID
322
+ * @param {"hot"|"recent"|"top"} category - category to filter posts
323
+ * @param {SidechatCursorString} [cursor] - cursor string
324
+ * @returns {SidechatPostsAndCursor} List of posts and cursor
325
+ */
326
+ getGroupPosts = async (groupID, category = "hot", cursor) => {
327
+ if (!this.userToken) {
328
+ throw new SidechatAPIError("User is not authenticated.");
329
+ }
330
+ try {
331
+ const res = await fetch(
332
+ `${this.apiRoot}/v1/posts?${
333
+ cursor ? "cursor=" + encodeURIComponent(cursor) + "&amp;" : ""
334
+ }group_id=${groupID}&amp;type=${category}`,
335
+ {
336
+ method: "GET",
337
+ headers: {
338
+ ...this.defaultHeaders,
339
+ Authorization: `Bearer ${this.userToken}`,
340
+ },
341
+ }
342
+ );
343
+ const json = await res.json();
344
+ return json;
345
+ } catch (err) {
346
+ console.error(err);
347
+ throw new SidechatAPIError(`Failed to get posts from group.`);
348
+ }
349
+ };
350
+
351
+ /**
352
+ * Upvote or downvote, or unvote a post
353
+ * @method
354
+ * @since 2.0.0-alpha.0
355
+ * @param {String} postID - post ID to vote on
356
+ * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote
357
+ */
358
+ setVote = async (postID, action) => {
359
+ if (!this.userToken) {
360
+ throw new SidechatAPIError("User is not authenticated.");
361
+ }
362
+ try {
363
+ const res = await fetch(`${this.apiRoot}/v1/posts/set_vote`, {
364
+ method: "POST",
365
+ headers: {
366
+ ...this.defaultHeaders,
367
+ Authorization: `Bearer ${this.userToken}`,
368
+ },
369
+ body: JSON.stringify({
370
+ post_id: postID,
371
+ vote_status: action,
372
+ }),
373
+ });
374
+ const json = await res.json();
375
+ return json;
376
+ } catch (err) {
377
+ console.error(err);
378
+ throw new SidechatAPIError(`Failed to change the vote on post.`);
379
+ }
380
+ };
381
+
382
+ /**
383
+ * Fetches a single post with just its ID
384
+ * @method
385
+ * @since 2.3.0
386
+ * @param {String} postID - ID of post to fetch
387
+ * @param {Boolean} includeDeleted - undocumented
388
+ * @returns {SidechatPostOrComment} post object
389
+ */
390
+ getPost = async (postID, includeDeleted = false) => {
391
+ if (!this.userToken) {
392
+ throw new SidechatAPIError("User is not authenticated.");
393
+ }
394
+ try {
395
+ const res = await fetch(
396
+ `${this.apiRoot}/v1/posts/get?include_deleted=${includeDeleted}&amp;post_id=${postID}`,
397
+ {
398
+ method: "GET",
399
+ headers: {
400
+ ...this.defaultHeaders,
401
+ Authorization: `Bearer ${this.userToken}`,
402
+ },
403
+ }
404
+ );
405
+ const json = await res.json();
406
+ return json.post;
407
+ } catch (err) {
408
+ console.error(err);
409
+ throw new SidechatAPIError(`Failed to get post from ID.`);
410
+ }
411
+ };
412
+
413
+ /**
414
+ * Fetches the posts or comments that the user has created
415
+ * @method
416
+ * @since 2.3.5
417
+ * @param {"posts"|"comments"} contentType - type of user content to fetch
418
+ * @returns {SidechatPostOrComment[]} post object
419
+ */
420
+ getUserContent = async (contentType) => {
421
+ if (!this.userToken) {
422
+ throw new SidechatAPIError("User is not authenticated.");
423
+ }
424
+ if (contentType == "posts") {
425
+ contentType = "my_posts";
426
+ } else if (contentType == "comments") {
427
+ contentType = "my_comments";
428
+ }
429
+ try {
430
+ const res = await fetch(`${this.apiRoot}/v1/posts&amp;type=${contentType}`, {
431
+ method: "GET",
432
+ headers: {
433
+ ...this.defaultHeaders,
434
+ Authorization: `Bearer ${this.userToken}`,
435
+ },
436
+ });
437
+ const json = await res.json();
438
+ return json.posts;
439
+ } catch (err) {
440
+ console.error(err);
441
+ throw new SidechatAPIError(`Failed to get content from user.`);
442
+ }
443
+ };
444
+
445
+ /**
446
+ * Get all the commments on a post
447
+ * @method
448
+ * @since 2.0.0-alpha.0
449
+ * @param {String} postID - post ID to get comments for
450
+ * @returns {SidechatPostOrComment[]} list of comments
451
+ */
452
+ getPostComments = async (postID) => {
453
+ if (!this.userToken) {
454
+ throw new SidechatAPIError("User is not authenticated.");
455
+ }
456
+ try {
457
+ const res = await fetch(
458
+ `${this.apiRoot}/v1/posts/comments/?post_id=${postID}`,
459
+ {
460
+ method: "GET",
461
+ headers: {
462
+ ...this.defaultHeaders,
463
+ Authorization: `Bearer ${this.userToken}`,
464
+ },
465
+ }
466
+ );
467
+ const json = await res.json();
468
+ // Function to preprocess the comments and organize them into a nested structure
469
+ function preprocessComments(apiComments) {
470
+ // Map to store comments by their IDs for efficient lookup
471
+ const commentMap = new Map();
472
+ // List to store top-level comments
473
+ const topLevelComments = [];
474
+
475
+ // Iterate through the API comments
476
+ apiComments.forEach((comment) => {
477
+ // Store the comment in the map with its ID as the key
478
+ commentMap.set(comment.id, comment);
479
+ // Get the parent comment using the reply_post_id
480
+ const parentComment = commentMap.get(comment.reply_post_id);
481
+ // Check if the comment is a top-level comment
482
+ if (
483
+ !parentComment ||
484
+ comment.reply_post_id === comment.parent_post_id
485
+ ) {
486
+ // If it's a top-level comment, push it to the topLevelComments array
487
+ topLevelComments.push(comment);
488
+ } else {
489
+ // If it's a reply, add it to the parent comment's replies array
490
+ if (!parentComment.replies) parentComment.replies = [];
491
+ parentComment.replies.push(comment);
492
+ }
493
+ });
494
+
495
+ // Flatten the nested structure and return a single list of comments
496
+ return flattenComments(topLevelComments);
497
+ }
498
+
499
+ // Function to flatten nested comments into a single list
500
+ function flattenComments(comments) {
501
+ // Use reduce to flatten the nested comments array into a single list
502
+ return comments.reduce((flatComments, comment) => {
503
+ // Push the current comment to the flatComments array
504
+ flatComments.push(comment);
505
+ // If the current comment has replies, recursively flatten them and push to the flatComments array
506
+ if (comment.replies)
507
+ flatComments.push(...flattenComments(comment.replies));
508
+ // Return the flatComments array
509
+ return flatComments;
510
+ }, []);
511
+ }
512
+
513
+ const sortedComments = preprocessComments(json.posts);
514
+ return sortedComments;
515
+ } catch (err) {
516
+ console.error(err);
517
+ throw new SidechatAPIError(`Failed to get comments on post.`);
518
+ }
519
+ };
520
+
521
+ /**
522
+ * Gets groups to be displayed on the "Explore Groups" page
523
+ * @method
524
+ * @since 2.0.0-alpha.0
525
+ * @param {Boolean} onePage - whether or not results should be returned as a single page
526
+ * @returns {SidechatGroup[]}
527
+ */
528
+ getAvailableGroups = async (onePage = true) => {
529
+ if (!this.userToken) {
530
+ throw new SidechatAPIError("User is not authenticated.");
531
+ }
532
+ try {
533
+ const res = await fetch(`${this.apiRoot}/v1/groups/explore`, {
534
+ method: "GET",
535
+ headers: {
536
+ ...this.defaultHeaders,
537
+ "App-Version": onePage ? "0" : this.defaultHeaders["App-Version"],
538
+ Authorization: `Bearer ${this.userToken}`,
539
+ },
540
+ });
541
+ const json = await res.json();
542
+ return await json.groups;
543
+ } catch (err) {
544
+ console.error(err);
545
+ throw new SidechatAPIError(`Failed to get groups from explore.`);
546
+ }
547
+ };
548
+
549
+ /**
550
+ * 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.
551
+ * @method
552
+ * @since 2.0.6
553
+ * @returns {SidechatLibraryAsset[]}
554
+ */
555
+ getAssetLibrary = async () => {
556
+ if (!this.userToken) {
557
+ throw new SidechatAPIError("User is not authenticated.");
558
+ }
559
+ try {
560
+ const res = await fetch(`${this.apiRoot}/v1/assets/library`, {
561
+ method: "GET",
562
+ headers: {
563
+ ...this.defaultHeaders,
564
+ Authorization: `Bearer ${this.userToken}`,
565
+ },
566
+ });
567
+ const json = await res.json();
568
+ return await json.items;
569
+ } catch (err) {
570
+ console.error(err);
571
+ throw new SidechatAPIError(`Failed to get asset library.`);
572
+ }
573
+ };
574
+
575
+ /**
576
+ * Gets the current authenticated user and a list of the groups of which they are members.
577
+ * @method
578
+ * @since 2.1.0
579
+ * @returns {SidechatCurrentUser}
580
+ */
581
+ getCurrentUser = async () => {
582
+ if (!this.userToken) {
583
+ throw new SidechatAPIError("User is not authenticated.");
584
+ }
585
+ try {
586
+ const res = await fetch(`${this.apiRoot}/v1/users/me`, {
587
+ method: "GET",
588
+ headers: {
589
+ ...this.defaultHeaders,
590
+ Authorization: `Bearer ${this.userToken}`,
591
+ },
592
+ });
593
+ const json = await res.json();
594
+ return await json;
595
+ } catch (err) {
596
+ console.error(err);
597
+ throw new SidechatAPIError(`Failed to get asset library.`);
598
+ }
599
+ };
600
+
601
+ /**
602
+ * Gets the metadata of a group from its ID
603
+ * @method
604
+ * @since 2.1.0
605
+ * @param {String} [groupID] - alphanumeric ID of a group to get. Falls back to user's primary group.
606
+ * @returns {SidechatGroup}
607
+ */
608
+ getGroupMetadata = async (groupID = "") => {
609
+ if (!this.userToken) {
610
+ throw new SidechatAPIError("User is not authenticated.");
611
+ }
612
+ try {
613
+ const res = await fetch(`${this.apiRoot}/v1/groups/${groupID}`, {
614
+ method: "GET",
615
+ headers: {
616
+ ...this.defaultHeaders,
617
+ Authorization: `Bearer ${this.userToken}`,
618
+ },
619
+ });
620
+ const json = await res.json();
621
+ return await json.group;
622
+ } catch (err) {
623
+ console.error(err);
624
+ throw new SidechatAPIError(`Failed to get group metadata.`);
625
+ }
626
+ };
627
+
628
+ /**
629
+ * Joins or leaves a group
630
+ * @method
631
+ * @param {String} groupID - alphanumeric ID of group to join or leave
632
+ * @param {Boolean} isMember - whether or not the user should be a member of the group
633
+ * @since 2.3.8
634
+ */
635
+ setGroupMembership = async (groupID, isMember) => {
636
+ if (!this.userToken) {
637
+ throw new SidechatAPIError("User is not authenticated.");
638
+ }
639
+ try {
640
+ const res = await fetch(
641
+ `${this.apiRoot}/v1/groups/${isMember ? "join" : "leave"}`,
642
+ {
643
+ method: "POST",
644
+ headers: {
645
+ ...this.defaultHeaders,
646
+ Authorization: `Bearer ${this.userToken}`,
647
+ },
648
+ body: JSON.stringify({
649
+ group_id: groupID,
650
+ }),
651
+ }
652
+ );
653
+ const json = await res.json();
654
+ return await json;
655
+ } catch (err) {
656
+ console.error(err);
657
+ throw new SidechatAPIError(`Failed to modify group membership.`);
658
+ }
659
+ };
660
+
661
+ /**
662
+ * Creates a comment on a post
663
+ * @method
664
+ * @since 2.2.0
665
+ * @param {String} parentPostID - alphanumeric ID of post on which this comment is made
666
+ * @param {String} text - text content of comment
667
+ * @param {String} groupID - alphanumeric ID of group in which the parent post resides
668
+ * @param {String} [replyCommentID] - alphanumeric ID of comment to reply to. Falls back to parentPostID
669
+ * @param {SidechatSimpleAsset[]} [assetList] - list of assets to attach
670
+ * @param {Boolean} [disableDMs] - prevent direct messages being sent to comment's author
671
+ * @param {Boolean} [anonymous] - whether or not to hide user's name and icon on comment
672
+ * @returns {SidechatPostOrComment} created comment
673
+ */
674
+ createComment = async (
675
+ parentPostID,
676
+ text,
677
+ groupID,
678
+ replyCommentID = parentPostID,
679
+ assetList = [],
680
+ disableDMs = false,
681
+ anonymous = false
682
+ ) => {
683
+ if (!this.userToken) {
684
+ throw new SidechatAPIError("User is not authenticated.");
685
+ }
686
+ try {
687
+ const res = await fetch(`${this.apiRoot}/v1/posts`, {
688
+ method: "POST",
689
+ headers: {
690
+ ...this.defaultHeaders,
691
+ Authorization: `Bearer ${this.userToken}`,
692
+ },
693
+ body: JSON.stringify({
694
+ type: "comment",
695
+ assets: assetList,
696
+ group_ids: [groupID],
697
+ text: text,
698
+ reply_post_id: replyCommentID,
699
+ parent_post_id: parentPostID,
700
+ dms_disabled: disableDMs,
701
+ using_identity: !anonymous,
702
+ }),
703
+ });
704
+ const json = await res.json();
705
+ return await json.comment;
706
+ } catch (err) {
707
+ console.error(err);
708
+ throw new SidechatAPIError(`Failed to post comment.`);
709
+ }
710
+ };
711
+
712
+ /**
713
+ * Creates a new post in the specified group
714
+ * @method
715
+ * @since 2.2.0
716
+ * @param {String} text - text content of comment
717
+ * @param {String} groupID - alphanumeric ID of group in which the parent post resides
718
+ * @param {SidechatSimpleAsset[]} [assetList] - list of assets to attach.
719
+ * @param {Boolean} [disableDMs] - prevent direct messages from being sent to post's author
720
+ * @param {Boolean} [disableComments] - whether or not comments should be disabled on post
721
+ * @param {Boolean} [anonymous] - whether or not to hide user's name and icon on post
722
+ * @returns {SidechatPostOrComment} the created post
723
+ */
724
+ createPost = async (
725
+ text,
726
+ groupID,
727
+ assetList = [],
728
+ disableDMs = false,
729
+ disableComments = false,
730
+ anonymous = false
731
+ ) => {
732
+ if (!this.userToken) {
733
+ throw new SidechatAPIError("User is not authenticated.");
734
+ }
735
+ try {
736
+ const res = await fetch(`${this.apiRoot}/v1/posts`, {
737
+ method: "POST",
738
+ headers: {
739
+ ...this.defaultHeaders,
740
+ Authorization: `Bearer ${this.userToken}`,
741
+ },
742
+ body: JSON.stringify({
743
+ type: "post",
744
+ assets: assetList,
745
+ group_ids: [groupID],
746
+ text: text,
747
+ attachments: [],
748
+ dms_disabled: disableDMs,
749
+ comments_disabled: disableComments,
750
+ using_identity: !anonymous,
751
+ }),
752
+ });
753
+ const json = await res.json();
754
+ return await json.posts[0];
755
+ } catch (err) {
756
+ console.error(err);
757
+ throw new SidechatAPIError(`Failed to make post.`);
758
+ }
759
+ };
760
+
761
+ /**
762
+ * Deletes a post or comment that the user created
763
+ * @method
764
+ * @since 2.2.0
765
+ * @param {String} postOrCommentID - alphanumeric ID of post to delete
766
+ */
767
+ deletePostOrComment = async (postOrCommentID) => {
768
+ if (!this.userToken) {
769
+ throw new SidechatAPIError("User is not authenticated.");
770
+ }
771
+ try {
772
+ const res = await fetch(`${this.apiRoot}/v1/posts/delete`, {
773
+ method: "POST",
774
+ headers: {
775
+ ...this.defaultHeaders,
776
+ Authorization: `Bearer ${this.userToken}`,
777
+ },
778
+ body: JSON.stringify({
779
+ post_id: postOrCommentID,
780
+ }),
781
+ });
782
+ const json = await res.json();
783
+ return await json;
784
+ } catch (err) {
785
+ console.error(err);
786
+ throw new SidechatAPIError(`Failed to delete post.`);
787
+ }
788
+ };
789
+
790
+ /**
791
+ * Sets the conversation icon of the current user
792
+ * @method
793
+ * @since 2.2.1
794
+ * @param {String} userID - alphanumeric ID of user
795
+ * @param {String} emoji - emoji to set as icon
796
+ * @param {String} primaryColor - hex string (including #) of primary color
797
+ * @param {String} secondaryColor - hex string (including #) of secondary color
798
+ */
799
+ setUserIcon = async (userID, emoji, primaryColor, secondaryColor) => {
800
+ if (!this.userToken) {
801
+ throw new SidechatAPIError("User is not authenticated.");
802
+ }
803
+ try {
804
+ const res = await fetch(`${this.apiRoot}/v1/users/${userID}`, {
805
+ method: "PATCH",
806
+ headers: {
807
+ ...this.defaultHeaders,
808
+ "App-Version": "0",
809
+ Authorization: `Bearer ${this.userToken}`,
810
+ },
811
+ body: JSON.stringify({
812
+ conversation_icon: {
813
+ emoji: emoji,
814
+ secondary_color: secondaryColor,
815
+ is_migrated: true,
816
+ color: primaryColor,
817
+ },
818
+ }),
819
+ });
820
+ const json = await res.json();
821
+ return await json;
822
+ } catch (err) {
823
+ console.error(err);
824
+ throw new SidechatAPIError(`Failed to set icon.`);
825
+ }
826
+ };
827
+
828
+ /**
829
+ * Checks if user can set their username to a string
830
+ * @method
831
+ * @since 2.3.6
832
+ * @param {String} username - string to check
833
+ * @returns {Boolean} whether or not username is valid and unused
834
+ */
835
+ checkUsername = async (username) => {
836
+ if (!this.userToken) {
837
+ throw new SidechatAPIError("User is not authenticated.");
838
+ }
839
+ try {
840
+ const res = await fetch(
841
+ `${this.apiRoot}/v1/users/username?username=${username}`,
842
+ {
843
+ method: "GET",
844
+ headers: {
845
+ ...this.defaultHeaders,
846
+ Authorization: `Bearer ${this.userToken}`,
847
+ },
848
+ }
849
+ );
850
+ if (res?.status == 200 || res?.status == 204) {
851
+ return true;
852
+ } else {
853
+ return false;
854
+ }
855
+ } catch (err) {
856
+ console.error(err);
857
+ throw new SidechatAPIError(`Failed to check username.`);
858
+ }
859
+ };
860
+
861
+ /**
862
+ * Changes the username of the current user
863
+ * @method
864
+ * @since 2.3.6
865
+ * @param {String} userID - alphanumeric ID of user
866
+ * @param {String} username - new username to set
867
+ */
868
+ setUsername = async (userID, username) => {
869
+ if (!this.userToken) {
870
+ throw new SidechatAPIError("User is not authenticated.");
871
+ }
872
+ try {
873
+ const res = await fetch(`${this.apiRoot}/v1/users/${userID}`, {
874
+ method: "PATCH",
875
+ headers: {
876
+ ...this.defaultHeaders,
877
+ Authorization: `Bearer ${this.userToken}`,
878
+ },
879
+ body: JSON.stringify({
880
+ username: username,
881
+ }),
882
+ });
883
+ const json = await res.json();
884
+ return await json.user;
885
+ } catch (err) {
886
+ console.error(err);
887
+ throw new SidechatAPIError(`Failed to set icon.`);
888
+ }
889
+ };
890
+
891
+ /**
892
+ * Marks an activity item as read
893
+ * @method
894
+ * @since 2.3.2
895
+ * @param {String} activityID - alphanumeric ID of activity object
896
+ */
897
+ readActivity = async (activityID) => {
898
+ if (!this.userToken) {
899
+ throw new SidechatAPIError("User is not authenticated.");
900
+ }
901
+ try {
902
+ const res = await fetch(`${this.apiRoot}/v1/activity/seen`, {
903
+ method: "POST",
904
+ headers: {
905
+ ...this.defaultHeaders,
906
+ Authorization: `Bearer ${this.userToken}`,
907
+ },
908
+ body: JSON.stringify({
909
+ ids: [activityID],
910
+ }),
911
+ });
912
+ const json = await res.json();
913
+ return await json;
914
+ } catch (err) {
915
+ console.error(err);
916
+ throw new SidechatAPIError(`Failed to mark activity as read.`);
917
+ }
918
+ };
919
+
920
+ /**
921
+ * Retrieves joinable group chats
922
+ * @method
923
+ * @since 2.3.5
924
+ */
925
+ getGroupChats = async () => {
926
+ if (!this.userToken) {
927
+ throw new SidechatAPIError("User is not authenticated.");
928
+ }
929
+ try {
930
+ const res = await fetch(`${this.apiRoot}/v1/chats/explore`, {
931
+ method: "GET",
932
+ headers: {
933
+ ...this.defaultHeaders,
934
+ Authorization: `Bearer ${this.userToken}`,
935
+ },
936
+ });
937
+ const json = await res.json();
938
+ return await json.chats;
939
+ } catch (err) {
940
+ console.error(err);
941
+ throw new SidechatAPIError(`Failed to get groupchats.`);
942
+ }
943
+ };
944
+
945
+ /**
946
+ * Joins a group chat
947
+ * @method
948
+ * @since 2.3.5
949
+ */
950
+ joinGroupChat = async (
951
+ groupChatID,
952
+ displayName,
953
+ emoji,
954
+ primaryColor,
955
+ secondaryColor
956
+ ) => {
957
+ if (!this.userToken) {
958
+ throw new SidechatAPIError("User is not authenticated.");
959
+ }
960
+ try {
961
+ const res = await fetch(`${this.apiRoot}/v1/chats/groups/join`, {
962
+ method: "POST",
963
+ headers: {
964
+ ...this.defaultHeaders,
965
+ Authorization: `Bearer ${this.userToken}`,
966
+ },
967
+ body: JSON.stringify({
968
+ chat_id: groupChatID,
969
+ identity: {
970
+ display_name: displayName,
971
+ emoji: emoji,
972
+ secondary_color: secondaryColor,
973
+ color: primaryColor,
974
+ },
975
+ }),
976
+ });
977
+ const json = await res.json();
978
+ return await json;
979
+ } catch (err) {
980
+ console.error(err);
981
+ throw new SidechatAPIError(`Failed to join groupchat.`);
982
+ }
983
+ };
984
+
985
+ /**
986
+ * Gets a list of the user's direct messages
987
+ * @method
988
+ * @returns {SidechatDirectThread[]}
989
+ * @since 2.4.4
990
+ */
991
+ getDMs = async () => {
992
+ if (!this.userToken) {
993
+ throw new SidechatAPIError("User is not authenticated.");
994
+ }
995
+ try {
996
+ const res = await fetch(`${this.apiRoot}/v1/chats`, {
997
+ method: "GET",
998
+ headers: {
999
+ ...this.defaultHeaders,
1000
+ Authorization: `Bearer ${this.userToken}`,
1001
+ },
1002
+ });
1003
+ const json = await res.json();
1004
+ const list = await json.chats;
1005
+ let r = [];
1006
+ list.forEach((o) => {
1007
+ r.push(o.chat);
1008
+ });
1009
+ return await r;
1010
+ } catch (err) {
1011
+ console.error(err);
1012
+ throw new SidechatAPIError(`Failed to fetch DMs.`);
1013
+ }
1014
+ };
1015
+
1016
+ /**
1017
+ * Gets a single direct message thread
1018
+ * @method
1019
+ * @param {String} id - alphanumeric ID of the chat to fetch
1020
+ * @returns {SidechatDirectThread}
1021
+ * @since 2.4.4
1022
+ */
1023
+ getDMThread = async (id) => {
1024
+ if (!this.userToken) {
1025
+ throw new SidechatAPIError("User is not authenticated.");
1026
+ }
1027
+ try {
1028
+ const res = await fetch(
1029
+ `${this.apiRoot}/v1/chats/messages?chat_id=${id}`,
1030
+ {
1031
+ method: "GET",
1032
+ headers: {
1033
+ ...this.defaultHeaders,
1034
+ Authorization: `Bearer ${this.userToken}`,
1035
+ },
1036
+ }
1037
+ );
1038
+ const json = await res.json();
1039
+ return await json.chat;
1040
+ } catch (err) {
1041
+ console.error(err);
1042
+ throw new SidechatAPIError(`Failed to fetch DM thread.`);
1043
+ }
1044
+ };
1045
+
1046
+ /**
1047
+ * Sends a message to an existing direct message thread - note that you must first use startDM() to start a thread.
1048
+ * @method
1049
+ * @param {String} chatID - alphanumeric ID of the chat to send to
1050
+ * @param {String} text - text content of message
1051
+ * @param {String} clientID - alphanumeric device ID
1052
+ * @param {SidechatAsset[]} - array of assets to send
1053
+ * @param {Boolean} anonymous - whether the DM should be sent anonymously
1054
+ * @since 2.4.4
1055
+ */
1056
+ sendDM = async (chatID, text, clientID, assets = [], anonymous = false) => {
1057
+ if (!this.userToken) {
1058
+ throw new SidechatAPIError("User is not authenticated.");
1059
+ }
1060
+ try {
1061
+ const res = await fetch(`${this.apiRoot}/v1/chats/send`, {
1062
+ method: "POST",
1063
+ headers: {
1064
+ ...this.defaultHeaders,
1065
+ Authorization: `Bearer ${this.userToken}`,
1066
+ },
1067
+ body: JSON.stringify({
1068
+ chat_id: chatID,
1069
+ text: text,
1070
+ client_id: clientID,
1071
+ anonymous: anonymous,
1072
+ assets: assets,
1073
+ }),
1074
+ });
1075
+ const json = await res.json();
1076
+ return await json;
1077
+ } catch (err) {
1078
+ console.error(err);
1079
+ throw new SidechatAPIError(`Failed to send message.`);
1080
+ }
1081
+ };
1082
+
1083
+ /**
1084
+ * Creates a new direct message thread
1085
+ * @method
1086
+ * @param {String} text - text content of message
1087
+ * @param {String} clientID - alphanumeric ID of devide
1088
+ * @param {String} postID - alphanumeric ID of post or comment
1089
+ * @param {Boolean} anonymous - whether the DM should be sent anonymously
1090
+ * @param {"feed"} postContext - context of post (mostly undocumented, defaults to "feed")
1091
+ * @since 2.4.4
1092
+ */
1093
+ startDM = async (
1094
+ text,
1095
+ clientID,
1096
+ postID,
1097
+ anonymous = false,
1098
+ postContext = "feed"
1099
+ ) => {
1100
+ if (!this.userToken) {
1101
+ throw new SidechatAPIError("User is not authenticated.");
1102
+ }
1103
+ try {
1104
+ const res = await fetch(`${this.apiRoot}/v1/chats/start`, {
1105
+ method: "POST",
1106
+ headers: {
1107
+ ...this.defaultHeaders,
1108
+ Authorization: `Bearer ${this.userToken}`,
1109
+ },
1110
+ body: JSON.stringify({
1111
+ text: text,
1112
+ client_id: clientID,
1113
+ post_id: postID,
1114
+ anonymous: anonymous,
1115
+ post_context: postContext,
1116
+ }),
1117
+ });
1118
+ const json = await res.json();
1119
+ return await json;
1120
+ } catch (err) {
1121
+ console.error(err);
1122
+ throw new SidechatAPIError(`Failed to start DM.`);
1123
+ }
1124
+ };
1125
+ }
1126
+
1127
+ export default SidechatAPIClient;
1128
+ </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"><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://offsides.micahlindley.com" 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 class="sidebar-section-children"><a href="SidechatColorList.html">SidechatColorList</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#SidechatColor">SidechatColor</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#SidechatDirectMessage">SidechatDirectMessage</a></div><div class="sidebar-section-children"><a href="global.html#SidechatDirectThread">SidechatDirectThread</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>