sidechat.js 2.0.0-alpha.0 → 2.0.1

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 (63) hide show
  1. package/README.md +2 -2
  2. package/dist/index.d.ts +3 -0
  3. package/dist/sidechat.cjs +1 -1
  4. package/dist/sidechat.cjs.map +1 -1
  5. package/dist/sidechat.modern.js +1 -1
  6. package/dist/sidechat.modern.js.map +1 -1
  7. package/dist/sidechat.module.js +1 -1
  8. package/dist/sidechat.module.js.map +1 -1
  9. package/dist/sidechat.umd.js +1 -1
  10. package/dist/sidechat.umd.js.map +1 -1
  11. package/dist/types.d.ts +229 -0
  12. package/docs/sidechat.js/2.0.0/SidechatAPIClient.html +3 -0
  13. package/docs/sidechat.js/2.0.0/SidechatAPIError.html +3 -0
  14. package/docs/sidechat.js/2.0.0/classes_SidechatAPIClient.js.html +425 -0
  15. package/docs/sidechat.js/2.0.0/classes_SidechatAPIError.js.html +16 -0
  16. package/docs/sidechat.js/2.0.0/data/search.json +1 -0
  17. package/docs/sidechat.js/2.0.0/fonts/Inconsolata-Regular.ttf +0 -0
  18. package/docs/sidechat.js/2.0.0/fonts/OpenSans-Regular.ttf +0 -0
  19. package/docs/sidechat.js/2.0.0/fonts/WorkSans-Bold.ttf +0 -0
  20. package/docs/sidechat.js/2.0.0/global.html +3 -0
  21. package/docs/sidechat.js/2.0.0/index.html +4 -0
  22. package/docs/sidechat.js/2.0.0/scripts/core.js +702 -0
  23. package/docs/sidechat.js/2.0.0/scripts/core.min.js +23 -0
  24. package/docs/sidechat.js/2.0.0/scripts/resize.js +90 -0
  25. package/docs/sidechat.js/2.0.0/scripts/search.js +265 -0
  26. package/docs/sidechat.js/2.0.0/scripts/search.min.js +6 -0
  27. package/docs/sidechat.js/2.0.0/scripts/third-party/Apache-License-2.0.txt +202 -0
  28. package/docs/sidechat.js/2.0.0/scripts/third-party/fuse.js +9 -0
  29. package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-line-num-original.js +369 -0
  30. package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-line-num.js +1 -0
  31. package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-original.js +5171 -0
  32. package/docs/sidechat.js/2.0.0/scripts/third-party/hljs.js +1 -0
  33. package/docs/sidechat.js/2.0.0/scripts/third-party/popper.js +5 -0
  34. package/docs/sidechat.js/2.0.0/scripts/third-party/tippy.js +1 -0
  35. package/docs/sidechat.js/2.0.0/scripts/third-party/tocbot.js +672 -0
  36. package/docs/sidechat.js/2.0.0/scripts/third-party/tocbot.min.js +1 -0
  37. package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-base.css +975 -0
  38. package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-dark.css +407 -0
  39. package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-light.css +388 -0
  40. package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme.min.css +1 -0
  41. package/docs/sidechat.js/2.0.0/tutorial-Authentication.html +13 -0
  42. package/docs/sidechat.js/2.0.0/tutorial-Email Registration.html +6 -0
  43. package/docs/sidechat.js/2.0.0/types_SidechatTypes.js.html +98 -0
  44. package/docs/sidechat.js/2.0.0-alpha.0/SidechatAPIClient.html +1 -1
  45. package/docs/sidechat.js/2.0.0-alpha.0/SidechatAPIError.html +3 -0
  46. package/docs/sidechat.js/2.0.0-alpha.0/classes_SidechatAPIClient.js.html +92 -48
  47. package/docs/sidechat.js/2.0.0-alpha.0/classes_SidechatAPIError.js.html +16 -0
  48. package/docs/sidechat.js/2.0.0-alpha.0/data/search.json +1 -1
  49. package/docs/sidechat.js/2.0.0-alpha.0/global.html +1 -1
  50. package/docs/sidechat.js/2.0.0-alpha.0/index.html +2 -2
  51. package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Authentication.html +13 -0
  52. package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Email Registration.html +6 -0
  53. package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Email Verification.html +6 -0
  54. package/docs/sidechat.js/2.0.0-alpha.0/types_SidechatTypes.js.html +19 -3
  55. package/docs/tutorials/Authentication.md +46 -0
  56. package/docs/tutorials/Email Registration.md +16 -0
  57. package/jsdoc.json +2 -1
  58. package/package.json +10 -3
  59. package/src/classes/SidechatAPIClient.js +96 -45
  60. package/src/classes/SidechatAPIError.js +5 -0
  61. package/src/index.js +2 -2
  62. package/src/tests/basicTest.js +14 -3
  63. package/src/types/SidechatTypes.js +17 -1
@@ -1 +1 @@
1
- {"version":3,"file":"sidechat.umd.js","sources":["../src/classes/SidechatAPIError.js","../src/classes/SidechatAPIClient.js"],"sourcesContent":["class SidechatAPIError extends Error {\r\n constructor(message) {\r\n super(message);\r\n this.name = \"SidechatAPIError\";\r\n }\r\n}\r\n\r\nexport default SidechatAPIError;\r\n","import \"../types/SidechatTypes.js\";\r\nimport SidechatAPIError from \"../classes/SidechatAPIError.js\";\r\n\r\n/**\r\n * API client class for making requests to Sidechat's private API. As of now all methods are static.\r\n * @class\r\n * @since 2.0.0-alpha.0\r\n * @todo Add functionality for constructing a client with or without a token and having it keep track of requests/caching, etc\r\n */\r\nclass SidechatAPIClient {\r\n static defaultHeaders = {\r\n Accept: \"application/json\",\r\n \"Content-Type\": \"application/json\",\r\n };\r\n\r\n /**\r\n * Initiate the login process with a phone number. Should be followed up with verifySMSCode().\r\n * @method\r\n * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to\r\n */\r\n static loginViaSMS = async (phoneNumber) => {\r\n try {\r\n const res = await fetch(`https://api.sidechat.lol/v1/login_register`, {\r\n method: \"POST\",\r\n headers: defaultHeaders,\r\n body: JSON.stringify({\r\n phone_number: `+1${phoneNumber}`,\r\n version: 3,\r\n }),\r\n });\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(error);\r\n throw new SidechatAPIError(\"Failed to request SMS verification.\");\r\n }\r\n };\r\n\r\n /**\r\n * Verify the code sent via SMS with loginViaSMS().\r\n * @method\r\n * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to\r\n * @param {String} code - the verification code\r\n */\r\n static verifySMSCode = async (phoneNumber, code) => {\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/verify_phone_number`,\r\n {\r\n method: \"POST\",\r\n headers: defaultHeaders,\r\n body: JSON.stringify({\r\n phone_number: `+1${phoneNumber}`,\r\n code: code.toUpperCase(),\r\n }),\r\n }\r\n );\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(\"Failed verify this code.\");\r\n }\r\n };\r\n\r\n /**\r\n * Set the user's age\r\n * @method\r\n * @param {Number} age - user's age in years\r\n * @param {String} registrationID - the registration ID generated by verifySMSCode()\r\n */\r\n static setAge = async (age, registrationID) => {\r\n if (age < 13) {\r\n throw new SidechatAPIError(\"You're too young to use Offsides.\");\r\n }\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/complete_registration`,\r\n {\r\n method: \"POST\",\r\n headers: defaultHeaders,\r\n body: JSON.stringify({\r\n age: Number(age),\r\n registration_id: registrationID,\r\n }),\r\n }\r\n );\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(\"Failed verify this code.\");\r\n }\r\n };\r\n\r\n /**\r\n * Initiate the email setup process. Should be followed up with checkEmailVerification().\r\n * @method\r\n * @param {String} email - school email address to send verification code to\r\n * @param {String} token - user bearer token\r\n */\r\n static registerEmail = async (email, token) => {\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v2/users/register_email`,\r\n {\r\n method: \"POST\",\r\n headers: {\r\n ...defaultHeaders,\r\n Authorization: `Bearer ${token}`,\r\n },\r\n body: JSON.stringify({\r\n email: email,\r\n }),\r\n }\r\n );\r\n const json = await res.json();\r\n if (json.message) {\r\n throw new SidechatAPIError(json.message);\r\n }\r\n return json;\r\n } catch (err) {\r\n console.error(error);\r\n throw new SidechatAPIError(\"Failed to request email verification.\");\r\n }\r\n };\r\n\r\n /**\r\n * Check is the user's email is verified.\r\n * @method\r\n * @param {String} token - user bearer token\r\n */\r\n static checkEmailVerification = async (token) => {\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/users/check_email_verified`,\r\n {\r\n method: \"GET\",\r\n headers: {\r\n ...defaultHeaders,\r\n Authorization: `Bearer ${token}`,\r\n },\r\n }\r\n );\r\n const json = await res.json();\r\n if (json.verified_email_updates_response) {\r\n return json.verified_email_updates_response;\r\n } else {\r\n throw new SidechatAPIError(json?.message || \"Email is not verified.\");\r\n }\r\n } catch (err) {\r\n console.error(error);\r\n throw new SidechatAPIError(\"Email is not verified.\");\r\n }\r\n };\r\n\r\n /**\r\n * Set the device ID of the current user\r\n * @method\r\n * @param {String} deviceId - the device ID to set\r\n * @param {String} token - the user bearer token\r\n */\r\n static setDeviceID = async (deviceID, token) => {\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/register_device_token`,\r\n {\r\n method: \"POST\",\r\n headers: {\r\n ...defaultHeaders,\r\n Authorization: `Bearer ${token}`,\r\n },\r\n body: JSON.stringify({\r\n build_type: \"release\",\r\n bundle_id: \"com.flowerave.sidechat\",\r\n device_token: deviceID,\r\n }),\r\n }\r\n );\r\n const json = await res.json();\r\n await AsyncStorage.setItem(\"deviceID\", deviceID);\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(\"Failed verify this code.\");\r\n }\r\n };\r\n\r\n /**\r\n * Get updated status for user and group\r\n * @method\r\n * @param {String} token - user bearer token\r\n * @param {String} [groupID] - ID of a specific group to retrieve info from\r\n */\r\n static getUserAndGroup = async (token, groupID = \"\") => {\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/updates?group_id=${groupID}`,\r\n {\r\n method: \"GET\",\r\n headers: {\r\n ...defaultHeaders,\r\n Authorization: `Bearer ${token}`,\r\n },\r\n }\r\n );\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to get posts from group.`);\r\n }\r\n };\r\n\r\n /**\r\n * Fetches posts from the specified category in a group\r\n * @method\r\n * @param {String} groupID - group ID\r\n * @param {String} token - user bearer token\r\n * @param {\"hot\"|\"recent\"|\"top\"} category - category to filter posts\r\n * @param {SidechatCursorString} [cursor] - cursor string\r\n * @returns {{posts: SidechatPostOrComment[], cursor: SidechatCursorString}} List of posts and cursor\r\n */\r\n static getGroupPosts = async (groupID, token, category = \"hot\", cursor) => {\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/posts?group_id=${groupID}&type=${category}${\r\n cursor ? \"&cursor=\" + cursor : \"\"\r\n }`,\r\n {\r\n method: \"GET\",\r\n headers: {\r\n ...defaultHeaders,\r\n Authorization: `Bearer ${token}`,\r\n },\r\n }\r\n );\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to get posts from group.`);\r\n }\r\n };\r\n\r\n /**\r\n * Upvote or downvote, or unvote a post\r\n * @method\r\n * @param {String} postID - post ID to vote on\r\n * @param {String} token - user bearer token\r\n * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote\r\n */\r\n static setVote = async (postID, token, action) => {\r\n try {\r\n const res = await fetch(`https://api.sidechat.lol/v1/posts/set_vote`, {\r\n method: \"POST\",\r\n headers: {\r\n ...defaultHeaders,\r\n Authorization: `Bearer ${token}`,\r\n },\r\n body: JSON.stringify({\r\n post_id: postID,\r\n vote_status: action,\r\n }),\r\n });\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to change the vote on post.`);\r\n }\r\n };\r\n\r\n /**\r\n * Get all the commments on a post\r\n * @method\r\n * @param {String} postID - post ID to get comments for\r\n * @param {String} token - user bearer token\r\n * @returns {SidechatPostOrComment[]} list of comments\r\n */\r\n static getPostComments = async (postID, token) => {\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/posts/comments/?post_id=${postID}`,\r\n {\r\n method: \"GET\",\r\n headers: {\r\n ...defaultHeaders,\r\n Authorization: `Bearer ${token}`,\r\n },\r\n }\r\n );\r\n const json = await res.json();\r\n // Function to preprocess the comments and organize them into a nested structure\r\n function preprocessComments(apiComments) {\r\n // Map to store comments by their IDs for efficient lookup\r\n const commentMap = new Map();\r\n // List to store top-level comments\r\n const topLevelComments = [];\r\n\r\n // Iterate through the API comments\r\n apiComments.forEach((comment) => {\r\n // Store the comment in the map with its ID as the key\r\n commentMap.set(comment.id, comment);\r\n // Get the parent comment using the reply_post_id\r\n const parentComment = commentMap.get(comment.reply_post_id);\r\n // Check if the comment is a top-level comment\r\n if (\r\n !parentComment ||\r\n comment.reply_post_id === comment.parent_post_id\r\n ) {\r\n // If it's a top-level comment, push it to the topLevelComments array\r\n topLevelComments.push(comment);\r\n } else {\r\n // If it's a reply, add it to the parent comment's replies array\r\n if (!parentComment.replies) parentComment.replies = [];\r\n parentComment.replies.push(comment);\r\n }\r\n });\r\n\r\n // Flatten the nested structure and return a single list of comments\r\n return flattenComments(topLevelComments);\r\n }\r\n\r\n // Function to flatten nested comments into a single list\r\n function flattenComments(comments) {\r\n // Use reduce to flatten the nested comments array into a single list\r\n return comments.reduce((flatComments, comment) => {\r\n // Push the current comment to the flatComments array\r\n flatComments.push(comment);\r\n // If the current comment has replies, recursively flatten them and push to the flatComments array\r\n if (comment.replies)\r\n flatComments.push(...flattenComments(comment.replies));\r\n // Return the flatComments array\r\n return flatComments;\r\n }, []);\r\n }\r\n\r\n const sortedComments = preprocessComments(json.posts);\r\n return sortedComments;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to get comments on post.`);\r\n }\r\n };\r\n\r\n /**\r\n * Gets groups to be displayed on the \"Explore Groups\" page\r\n * @method\r\n * @param {String} token - user bearer token\r\n * @returns {SidechatGroup}\r\n */\r\n static getAvailableGroups = async (token) => {\r\n try {\r\n const res = await fetch(`https://api.sidechat.lol/v1/groups/explore`, {\r\n method: \"GET\",\r\n headers: {\r\n ...defaultHeaders,\r\n Authorization: `Bearer ${token}`,\r\n },\r\n });\r\n const json = await res.json();\r\n return json.groups;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to get groups from explore.`);\r\n }\r\n };\r\n}\r\n\r\nexport default SidechatAPIClient;\r\n"],"names":["SidechatAPIError","_Error","message","_this","call","name","_wrapNativeSuper","Error","_catch","body","recover","result","e","then","SidechatAPIClient","defaultHeaders","Accept","loginViaSMS","phoneNumber","Promise","resolve","fetch","method","headers","JSON","stringify","phone_number","version","res","json","console","error","reject","verifySMSCode","code","toUpperCase","err","setAge","age","registrationID","Number","registration_id","registerEmail","email","token","_extends","Authorization","checkEmailVerification","verified_email_updates_response","setDeviceID","deviceID","build_type","bundle_id","device_token","AsyncStorage","setItem","getUserAndGroup","groupID","getGroupPosts","category","cursor","setVote","postID","action","post_id","vote_status","getPostComments","preprocessComments","apiComments","commentMap","Map","topLevelComments","forEach","comment","set","id","parentComment","get","reply_post_id","parent_post_id","replies","push","flattenComments","comments","reduce","flatComments","apply","posts","getAvailableGroups","groups"],"mappings":"giDAAMA,IAAAA,wBAAgBC,WACpB,SAAAD,EAAYE,GAASC,IAAAA,EAEY,OAD/BA,EAAAF,EAAAG,UAAMF,UACDG,KAAO,mBAAmBF,CACjC,CAAC,SAJmBF,KAAAD,yEAInBA,CAAA,eAAAM,EAJ4BC,QCkjBxB,SAASC,EAAOC,EAAMC,GAC5B,IACC,IAAIC,EAASF,GACd,CAAE,MAAMG,GACP,OAAOF,EAAQE,EAChB,CACA,OAAID,GAAUA,EAAOE,KACbF,EAAOE,UAAK,EAAQH,GAErBC,CACR,CAnjBM,IAAAG,EAAiB,aAAjBA,EACGC,eAAiB,CACtBC,OAAQ,mBACR,eAAgB,oBAHdF,EAWGG,YAAW,SAAUC,GAAW,WAAKC,QAAAC,QAAAZ,aACtCW,OAAAA,QAAAC,QACgBC,MAAK,6CAA+C,CACpEC,OAAQ,OACRC,QAASR,eACTN,KAAMe,KAAKC,UAAU,CACnBC,aAAmBR,KAAAA,EACnBS,QAAS,OAEXd,KAAA,SAPIe,GAAGT,OAAAA,QAAAC,QAQUQ,EAAIC,SAEzB,EAAC,WAEC,MADAC,QAAQC,MAAMA,OACJ,IAAA/B,EAAiB,sCAC7B,GACF,CAAC,MAAAY,GAAAO,OAAAA,QAAAa,OAAApB,EA3BGE,CAAAA,EAAAA,EAmCGmB,uBAAuBf,EAAagB,GAAS,IAAA,OAAAf,QAAAC,QAAAZ,aAC9CW,OAAAA,QAAAC,QACgBC,MAEhB,kDAAA,CACEC,OAAQ,OACRC,QAASR,eACTN,KAAMe,KAAKC,UAAU,CACnBC,kBAAmBR,EACnBgB,KAAMA,EAAKC,mBAGhBtB,KAAA,SAVKe,GAAG,OAAAT,QAAAC,QAWUQ,EAAIC,OAEzB,EAAA,WAASO,GAEP,MADAN,QAAQC,MAAMK,GACJ,IAAApC,EAAiB,2BAC7B,GACF,CAAC,MAAAY,GAAAO,OAAAA,QAAAa,OAAApB,EAtDGE,CAAAA,EAAAA,EA8DGuB,gBAAgBC,EAAKC,GAAmB,IAC7C,GAAID,EAAM,GACR,MAAM,IAAItC,EAAiB,qCAC5B,OAAAmB,QAAAC,QAAAZ,EACG,WAAA,OAAAW,QAAAC,QACgBC,0DAEhB,CACEC,OAAQ,OACRC,QAASR,eACTN,KAAMe,KAAKC,UAAU,CACnBa,IAAKE,OAAOF,GACZG,gBAAiBF,OAGtB1B,cAVKe,GAAG,OAAAT,QAAAC,QAWUQ,EAAIC,OAEzB,EAAA,WAASO,GAEP,MADAN,QAAQC,MAAMK,GACJ,IAAApC,EAAiB,2BAC7B,GACF,CAAC,MAAAY,GAAAO,OAAAA,QAAAa,OAAApB,EAAA,CAAA,EApFGE,EA4FG4B,uBAAuBC,EAAOC,GAAU,IAAA,OAAAzB,QAAAC,QAAAZ,aACzCW,OAAAA,QAAAC,QACgBC,MAAK,mDAErB,CACEC,OAAQ,OACRC,QAAOsB,EAAA,CAAA,EACF9B,eAAc,CACjB+B,cAAyBF,UAAAA,IAE3BnC,KAAMe,KAAKC,UAAU,CACnBkB,MAAOA,OAGZ9B,KAAA,SAZKe,GAAGT,OAAAA,QAAAC,QAaUQ,EAAIC,QAAMhB,KAAA,SAAvBgB,GACN,GAAIA,EAAK3B,QACP,MAAU,IAAAF,EAAiB6B,EAAK3B,SAElC,OAAO2B,CAAK,EAAA,EACd,EAAc,WAEZ,MADAC,QAAQC,MAAMA,WACJ/B,EAAiB,wCAC7B,GACF,CAAC,MAAAY,UAAAO,QAAAa,OAAApB,EApHGE,CAAAA,EAAAA,EA2HGiC,uBAAsB,SAAUH,GAAU,IAAA,OAAAzB,QAAAC,QAAAZ,aAC3CW,OAAAA,QAAAC,QACgBC,MAEhB,yDAAA,CACEC,OAAQ,MACRC,QAAOsB,EAAA,CAAA,EACF9B,eACH+B,CAAAA,cAAyBF,UAAAA,OAG9B/B,KAAA,SATKe,GAAGT,OAAAA,QAAAC,QAUUQ,EAAIC,QAAMhB,KAAA,SAAvBgB,GAAI,GACNA,EAAKmB,gCACP,OAAOnB,EAAKmB,gCAEZ,UAAUhD,SAAiB6B,SAAAA,EAAM3B,UAAW,yBAA0B,EAAA,EAE1E,EAAc,WAEZ,MADA4B,QAAQC,MAAMA,WACJ/B,EAAiB,yBAC7B,GACF,CAAC,MAAAY,UAAAO,QAAAa,OAAApB,EAjJGE,CAAAA,EAAAA,EAyJGmC,YAAW,SAAUC,EAAUN,OAAUzB,OAAAA,QAAAC,QAAAZ,EAAA,kBAC1CW,QAAAC,QACgBC,MAEhB,oDAAA,CACEC,OAAQ,OACRC,QAAOsB,EACF9B,CAAAA,EAAAA,eACH+B,CAAAA,wBAAyBF,IAE3BnC,KAAMe,KAAKC,UAAU,CACnB0B,WAAY,UACZC,UAAW,yBACXC,aAAcH,OAGnBrC,cAdKe,GAAG,OAAAT,QAAAC,QAeUQ,EAAIC,QAAMhB,cAAvBgB,GAAI,OAAAV,QAAAC,QACJkC,aAAaC,QAAQ,WAAYL,IAASrC,gBAChD,OAAOgB,CAAK,EACd,EAAA,EAAA,EAASO,SAAAA,GAEP,MADAN,QAAQC,MAAMK,GACR,IAAIpC,EAAiB,2BAC7B,GACF,CAAC,MAAAY,GAAA,OAAAO,QAAAa,OAAApB,EAAA,CAAA,EAjLGE,EAyLG0C,gBAAyBZ,SAAAA,EAAOa,QAAAA,IAAAA,IAAAA,EAAU,IAAE,IAAKtC,OAAAA,QAAAC,QAAAZ,EAClD,WAAA,OAAAW,QAAAC,QACgBC,sDACgCoC,EAChD,CACEnC,OAAQ,MACRC,QAAOsB,KACF9B,eAAc,CACjB+B,cAAyBF,UAAAA,OAG9B/B,cATKe,GAAG,OAAAT,QAAAC,QAUUQ,EAAIC,OAEzB,EAAA,WAASO,GAEP,MADAN,QAAQC,MAAMK,GACJ,IAAApC,EAAkD,kCAC9D,GACF,CAAC,MAAAY,UAAAO,QAAAa,OAAApB,EA3MGE,CAAAA,EAAAA,EAsNG4C,cAAa,SAAUD,EAASb,EAAOe,EAAkBC,QAAlBD,IAAAA,IAAAA,EAAW,OAAK,WAAaxC,QAAAC,QAAAZ,EACrE,WAAA,OAAAW,QAAAC,QACgBC,MAAK,8CACyBoC,EAAO,SAASE,GAC5DC,EAAS,WAAaA,EAAS,IAEjC,CACEtC,OAAQ,MACRC,QAAOsB,EACF9B,CAAAA,EAAAA,eACH+B,CAAAA,wBAAyBF,OAG9B/B,KAXKe,SAAAA,GAAGT,OAAAA,QAAAC,QAYUQ,EAAIC,OAAM,EAE/B,EAAC,SAAQO,GAEP,MADAN,QAAQC,MAAMK,OACJpC,oCACZ,GACF,CAAC,MAAAY,GAAA,OAAAO,QAAAa,OAAApB,EAAA,CAAA,EA1OGE,EAmPG+C,QAAiBC,SAAAA,EAAQlB,EAAOmB,GAAW,IAAA,OAAA5C,QAAAC,QAAAZ,aAC5CW,OAAAA,QAAAC,QACgBC,MAAoD,6CAAA,CACpEC,OAAQ,OACRC,QAAOsB,EAAA,CAAA,EACF9B,eACH+B,CAAAA,cAAyBF,UAAAA,IAE3BnC,KAAMe,KAAKC,UAAU,CACnBuC,QAASF,EACTG,YAAaF,OAEflD,cAVIe,GAAG,OAAAT,QAAAC,QAWUQ,EAAIC,OAEzB,EAAA,WAASO,GAEP,MADAN,QAAQC,MAAMK,GACJ,IAAApC,EAAqD,qCACjE,GACF,CAAC,MAAAY,UAAAO,QAAAa,OAAApB,EAtQGE,CAAAA,EAAAA,EA+QGoD,gBAAe,SAAUJ,EAAQlB,OAAUzB,OAAAA,QAAAC,QAAAZ,EAAA,kBAC5CW,QAAAC,QACgBC,MACuCyC,uDAAAA,EACvD,CACExC,OAAQ,MACRC,QAAOsB,EACF9B,CAAAA,EAAAA,gBACH+B,cAAa,UAAYF,OAG9B/B,KATKe,SAAAA,GAYN,SAASuC,EAAmBC,GAE1B,IAAMC,EAAa,IAAIC,IAEjBC,EAAmB,GAuBzB,OApBAH,EAAYI,QAAQ,SAACC,GAEnBJ,EAAWK,IAAID,EAAQE,GAAIF,GAE3B,IAAMG,EAAgBP,EAAWQ,IAAIJ,EAAQK,eAG1CF,GACDH,EAAQK,gBAAkBL,EAAQM,gBAM7BH,EAAcI,UAASJ,EAAcI,QAAU,IACpDJ,EAAcI,QAAQC,KAAKR,IAJ3BF,EAAiBU,KAAKR,EAM1B,GAGOS,EAAgBX,EACzB,CAGA,SAASW,EAAgBC,GAEvB,OAAOA,EAASC,OAAO,SAACC,EAAcZ,GAOpC,OALAY,EAAaJ,KAAKR,GAEdA,EAAQO,SACVK,EAAaJ,KAAIK,MAAjBD,EAAqBH,EAAgBT,EAAQO,UAExCK,CACT,EAAG,GACL,CAAC,OAAAlE,QAAAC,QA5CkBQ,EAAIC,QAAMhB,KAAvBgB,SAAAA,GA+CN,OADuBsC,EAAmBtC,EAAK0D,MACzB,EACxB,EAAA,WAASnD,GAEP,MADAN,QAAQC,MAAMK,GACJ,IAAApC,EAAgB,kCAC5B,GACF,CAAC,MAAAY,UAAAO,QAAAa,OAAApB,EA/UGE,CAAAA,EAAAA,EAuVG0E,mBAAkB,SAAU5C,GAAU,IAAA,OAAAzB,QAAAC,QAAAZ,aACvCW,OAAAA,QAAAC,QACgBC,MAAK,6CAA+C,CACpEC,OAAQ,MACRC,QAAOsB,EAAA,CAAA,EACF9B,eAAc,CACjB+B,cAAyBF,UAAAA,OAE3B/B,KAAA,SANIe,GAAG,OAAAT,QAAAC,QAOUQ,EAAIC,QAAMhB,cAAvBgB,GACN,OAAOA,EAAK4D,MAAO,EAAA,EACrB,EAAC,SAAQrD,GAEP,MADAN,QAAQC,MAAMK,OACJpC,uCACZ,GACF,CAAC,MAAAY,GAAAO,OAAAA,QAAAa,OAAApB,EAGH,CAAA"}
1
+ {"version":3,"file":"sidechat.umd.js","sources":["../src/classes/SidechatAPIError.js","../src/classes/SidechatAPIClient.js"],"sourcesContent":["/**\r\n * Throwable error caused by the Sidechat API\r\n * @class\r\n * @extends Error\r\n */\r\nclass SidechatAPIError extends Error {\r\n constructor(message) {\r\n super(message);\r\n this.name = \"SidechatAPIError\";\r\n }\r\n}\r\n\r\nexport default SidechatAPIError;\r\n","import \"../types/SidechatTypes.js\";\r\nimport SidechatAPIError from \"../classes/SidechatAPIError.js\";\r\n\r\n/**\r\n * API client class for making requests to Sidechat's private API. You'll need to [authenticate]{@tutorial Authentication} before using most of the methods.\r\n * @class\r\n * @since 2.0.0-alpha.0\r\n */\r\nclass SidechatAPIClient {\r\n /**\r\n * User bearer token\r\n * @type {SidechatAuthToken}\r\n * */\r\n userToken;\r\n /**\r\n * Default headers for every API request\r\n * @type {Object}\r\n * @static\r\n */\r\n defaultHeaders = {\r\n Accept: \"application/json\",\r\n \"Content-Type\": \"application/json\",\r\n };\r\n\r\n /**\r\n * Create a new instance of the API client\r\n * @param {SidechatAuthToken} [token] - user bearer token\r\n */\r\n constructor(token = \"\") {\r\n if (token) {\r\n this.userToken = token;\r\n }\r\n }\r\n\r\n /**\r\n * 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\r\n * @method\r\n * @param {SidechatAuthToken} token - user bearer token\r\n */\r\n setToken = (token) => {\r\n this.userToken = token;\r\n };\r\n\r\n /**\r\n * Initiate the login process with a phone number. Should be followed up with verifySMSCode().\r\n * @method\r\n * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to\r\n */\r\n loginViaSMS = async (phoneNumber) => {\r\n try {\r\n const res = await fetch(`https://api.sidechat.lol/v1/login_register`, {\r\n method: \"POST\",\r\n headers: this.defaultHeaders,\r\n body: JSON.stringify({\r\n phone_number: `+1${phoneNumber}`,\r\n version: 3,\r\n }),\r\n });\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(\"Failed to request SMS verification.\");\r\n }\r\n };\r\n\r\n /**\r\n * Verify the code sent via SMS with loginViaSMS().\r\n * @method\r\n * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to\r\n * @param {String} code - the verification code\r\n */\r\n verifySMSCode = async (phoneNumber, code) => {\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/verify_phone_number`,\r\n {\r\n method: \"POST\",\r\n headers: this.defaultHeaders,\r\n body: JSON.stringify({\r\n phone_number: `+1${phoneNumber}`,\r\n code: code.toUpperCase(),\r\n }),\r\n }\r\n );\r\n const json = await res.json();\r\n if (json?.logged_in_user?.token) {\r\n this.userToken = json.logged_in_user.token;\r\n }\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(\"Failed verify this code.\");\r\n }\r\n };\r\n\r\n /**\r\n * Set the user's age\r\n * @method\r\n * @param {Number} age - user's age in years\r\n * @param {String} registrationID - the registration ID generated by verifySMSCode()\r\n */\r\n setAge = async (age, registrationID) => {\r\n if (age < 13) {\r\n throw new SidechatAPIError(\"You're too young to use Offsides.\");\r\n }\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/complete_registration`,\r\n {\r\n method: \"POST\",\r\n headers: this.defaultHeaders,\r\n body: JSON.stringify({\r\n age: Number(age),\r\n registration_id: registrationID,\r\n }),\r\n }\r\n );\r\n const json = await res.json();\r\n if (json.token) {\r\n this.userToken = json.token;\r\n }\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(\"Failed verify this code.\");\r\n }\r\n };\r\n\r\n /**\r\n * Initiate the email setup process. Should be followed up with checkEmailVerification().\r\n * @method\r\n * @param {String} email - school email address to send verification code to\r\n * @tutorial Email Registration\r\n */\r\n registerEmail = async (email) => {\r\n if (!this.userToken) {\r\n throw new SidechatAPIError(\"User is not authenticated.\");\r\n }\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v2/users/register_email`,\r\n {\r\n method: \"POST\",\r\n headers: {\r\n ...this.defaultHeaders,\r\n Authorization: `Bearer ${this.userToken}`,\r\n },\r\n body: JSON.stringify({\r\n email: email,\r\n }),\r\n }\r\n );\r\n const json = await res.json();\r\n if (json.message) {\r\n throw new SidechatAPIError(json.message);\r\n }\r\n return json;\r\n } catch (err) {\r\n console.error(error);\r\n throw new SidechatAPIError(\"Failed to request email verification.\");\r\n }\r\n };\r\n\r\n /**\r\n * Check is the user's email is verified.\r\n * @method\r\n */\r\n checkEmailVerification = async () => {\r\n if (!this.userToken) {\r\n throw new SidechatAPIError(\"User is not authenticated.\");\r\n }\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/users/check_email_verified`,\r\n {\r\n method: \"GET\",\r\n headers: {\r\n ...this.defaultHeaders,\r\n Authorization: `Bearer ${this.userToken}`,\r\n },\r\n }\r\n );\r\n const json = await res.json();\r\n if (json.verified_email_updates_response) {\r\n return json.verified_email_updates_response;\r\n } else {\r\n throw new SidechatAPIError(json?.message || \"Email is not verified.\");\r\n }\r\n } catch (err) {\r\n console.error(error);\r\n throw new SidechatAPIError(\"Email is not verified.\");\r\n }\r\n };\r\n\r\n /**\r\n * Set the device ID of the current user\r\n * @method\r\n * @param {String} deviceId - the device ID to set\r\n */\r\n setDeviceID = async (deviceID) => {\r\n if (!this.userToken) {\r\n throw new SidechatAPIError(\"User is not authenticated.\");\r\n }\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/register_device_token`,\r\n {\r\n method: \"POST\",\r\n headers: {\r\n ...this.defaultHeaders,\r\n Authorization: `Bearer ${this.userToken}`,\r\n },\r\n body: JSON.stringify({\r\n build_type: \"release\",\r\n bundle_id: \"com.flowerave.sidechat\",\r\n device_token: deviceID,\r\n }),\r\n }\r\n );\r\n const json = await res.json();\r\n await AsyncStorage.setItem(\"deviceID\", deviceID);\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(\"Failed verify this code.\");\r\n }\r\n };\r\n\r\n /**\r\n * Get updated status for user and group\r\n * @method\r\n * @param {String} [groupID] - ID of a specific group to retrieve info from\r\n */\r\n getUserAndGroup = async (groupID = \"\") => {\r\n if (!this.userToken) {\r\n throw new SidechatAPIError(\"User is not authenticated.\");\r\n }\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/updates?group_id=${groupID}`,\r\n {\r\n method: \"GET\",\r\n headers: {\r\n ...this.defaultHeaders,\r\n Authorization: `Bearer ${this.userToken}`,\r\n },\r\n }\r\n );\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to get posts from group.`);\r\n }\r\n };\r\n\r\n /**\r\n * Fetches posts from the specified category in a group\r\n * @method\r\n * @param {String} groupID - group ID\r\n * @param {\"hot\"|\"recent\"|\"top\"} category - category to filter posts\r\n * @param {SidechatCursorString} [cursor] - cursor string\r\n * @returns {SidechatPostsAndCursor} List of posts and cursor\r\n */\r\n getGroupPosts = async (groupID, category = \"hot\", cursor) => {\r\n if (!this.userToken) {\r\n throw new SidechatAPIError(\"User is not authenticated.\");\r\n }\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/posts?group_id=${groupID}&type=${category}${\r\n cursor ? \"&cursor=\" + cursor : \"\"\r\n }`,\r\n {\r\n method: \"GET\",\r\n headers: {\r\n ...this.defaultHeaders,\r\n Authorization: `Bearer ${this.userToken}`,\r\n },\r\n }\r\n );\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to get posts from group.`);\r\n }\r\n };\r\n\r\n /**\r\n * Upvote or downvote, or unvote a post\r\n * @method\r\n * @param {String} postID - post ID to vote on\r\n * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote\r\n */\r\n setVote = async (postID, action) => {\r\n if (!this.userToken) {\r\n throw new SidechatAPIError(\"User is not authenticated.\");\r\n }\r\n try {\r\n const res = await fetch(`https://api.sidechat.lol/v1/posts/set_vote`, {\r\n method: \"POST\",\r\n headers: {\r\n ...this.defaultHeaders,\r\n Authorization: `Bearer ${this.userToken}`,\r\n },\r\n body: JSON.stringify({\r\n post_id: postID,\r\n vote_status: action,\r\n }),\r\n });\r\n const json = await res.json();\r\n return json;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to change the vote on post.`);\r\n }\r\n };\r\n\r\n /**\r\n * Get all the commments on a post\r\n * @method\r\n * @param {String} postID - post ID to get comments for\r\n * @returns {SidechatPostOrComment[]} list of comments\r\n */\r\n getPostComments = async (postID) => {\r\n if (!this.userToken) {\r\n throw new SidechatAPIError(\"User is not authenticated.\");\r\n }\r\n try {\r\n const res = await fetch(\r\n `https://api.sidechat.lol/v1/posts/comments/?post_id=${postID}`,\r\n {\r\n method: \"GET\",\r\n headers: {\r\n ...this.defaultHeaders,\r\n Authorization: `Bearer ${this.userToken}`,\r\n },\r\n }\r\n );\r\n const json = await res.json();\r\n // Function to preprocess the comments and organize them into a nested structure\r\n function preprocessComments(apiComments) {\r\n // Map to store comments by their IDs for efficient lookup\r\n const commentMap = new Map();\r\n // List to store top-level comments\r\n const topLevelComments = [];\r\n\r\n // Iterate through the API comments\r\n apiComments.forEach((comment) => {\r\n // Store the comment in the map with its ID as the key\r\n commentMap.set(comment.id, comment);\r\n // Get the parent comment using the reply_post_id\r\n const parentComment = commentMap.get(comment.reply_post_id);\r\n // Check if the comment is a top-level comment\r\n if (\r\n !parentComment ||\r\n comment.reply_post_id === comment.parent_post_id\r\n ) {\r\n // If it's a top-level comment, push it to the topLevelComments array\r\n topLevelComments.push(comment);\r\n } else {\r\n // If it's a reply, add it to the parent comment's replies array\r\n if (!parentComment.replies) parentComment.replies = [];\r\n parentComment.replies.push(comment);\r\n }\r\n });\r\n\r\n // Flatten the nested structure and return a single list of comments\r\n return flattenComments(topLevelComments);\r\n }\r\n\r\n // Function to flatten nested comments into a single list\r\n function flattenComments(comments) {\r\n // Use reduce to flatten the nested comments array into a single list\r\n return comments.reduce((flatComments, comment) => {\r\n // Push the current comment to the flatComments array\r\n flatComments.push(comment);\r\n // If the current comment has replies, recursively flatten them and push to the flatComments array\r\n if (comment.replies)\r\n flatComments.push(...flattenComments(comment.replies));\r\n // Return the flatComments array\r\n return flatComments;\r\n }, []);\r\n }\r\n\r\n const sortedComments = preprocessComments(json.posts);\r\n return sortedComments;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to get comments on post.`);\r\n }\r\n };\r\n\r\n /**\r\n * Gets groups to be displayed on the \"Explore Groups\" page\r\n * @method\r\n * @returns {SidechatGroup[]}\r\n */\r\n getAvailableGroups = async () => {\r\n if (!this.userToken) {\r\n throw new SidechatAPIError(\"User is not authenticated.\");\r\n }\r\n try {\r\n const res = await fetch(`https://api.sidechat.lol/v1/groups/explore`, {\r\n method: \"GET\",\r\n headers: {\r\n ...this.defaultHeaders,\r\n Authorization: `Bearer ${this.userToken}`,\r\n },\r\n });\r\n const json = await res.json();\r\n return await json.groups;\r\n } catch (err) {\r\n console.error(err);\r\n throw new SidechatAPIError(`Failed to get groups from explore.`);\r\n }\r\n };\r\n}\r\n\r\nexport default SidechatAPIClient;\r\n"],"names":["SidechatAPIError","_Error","message","_this","call","name","_wrapNativeSuper","Error","_catch","body","recover","result","e","then","token","_this2","this","_this3","_this4","_this5","_this6","_this7","_this8","_this9","_this10","_this11","_this12","defaultHeaders","Accept","setToken","userToken","loginViaSMS","phoneNumber","Promise","resolve","fetch","method","headers","JSON","stringify","phone_number","version","res","json","err","console","error","reject","verifySMSCode","code","toUpperCase","_json$logged_in_user","logged_in_user","setAge","age","registrationID","Number","registration_id","registerEmail","email","_extends","Authorization","checkEmailVerification","verified_email_updates_response","setDeviceID","deviceID","build_type","bundle_id","device_token","AsyncStorage","setItem","getUserAndGroup","groupID","getGroupPosts","category","cursor","setVote","postID","action","post_id","vote_status","getPostComments","preprocessComments","apiComments","commentMap","Map","topLevelComments","forEach","comment","set","id","parentComment","get","reply_post_id","parent_post_id","replies","push","flattenComments","comments","reduce","flatComments","apply","posts","getAvailableGroups","groups"],"mappings":"giDAKMA,IAAAA,wBAAgBC,WACpB,SAAAD,EAAYE,GAASC,IAAAA,EAEY,OAD/BA,EAAAF,EAAAG,UAAMF,UACDG,KAAO,mBAAmBF,CACjC,CAAC,SAJmBF,KAAAD,yEAInBA,CAAA,eAAAM,EAJ4BC,QC6iBxB,SAASC,EAAOC,EAAMC,GAC5B,IACC,IAAIC,EAASF,GACd,CAAE,MAAMG,GACP,OAAOF,EAAQE,EAChB,CACA,OAAID,GAAUA,EAAOE,KACbF,EAAOE,UAAK,EAAQH,GAErBC,CACR,qBAhiBE,SAAYG,GAAYC,IAAAA,EAwBTC,KAAIC,EA0BFD,KAAIE,EAiCJF,KAAIG,EAyBdH,KAAII,EAiCJJ,KAAIK,EAgCJL,KAAIM,EAkCJN,KAAIO,EA+BJP,KAAIQ,EA+BJR,KAAIS,EA8BJT,KAAIU,EA0EJV,KAAIb,EArXCW,cAAAA,IAAAA,EAAQ,IATpBa,KAAAA,eAAiB,CACfC,OAAQ,mBACR,eAAgB,yBAkBlBC,SAAW,SAACf,GACVX,EAAK2B,UAAYhB,CACnB,OAOAiB,YAAW,SAAUC,GAAW,IAAKC,OAAAA,QAAAC,QAAA1B,EAC/B,WAAA,OAAAyB,QAAAC,QACgBC,MAAoD,6CAAA,CACpEC,OAAQ,OACRC,QAAStB,EAAKY,eACdlB,KAAM6B,KAAKC,UAAU,CACnBC,aAAY,KAAOR,EACnBS,QAAS,OAEX5B,KAAA,SAPI6B,GAAG,OAAAT,QAAAC,QAQUQ,EAAIC,OAAM,EAE/B,EAASC,SAAAA,GAEP,MADAC,QAAQC,MAAMF,OACJ5C,EAAiB,sCAC7B,GACF,CAAC,MAAAY,GAAAqB,OAAAA,QAAAc,OAAAnC,EAQDoC,CAAAA,EAAAA,KAAAA,cAAuBhB,SAAAA,EAAaiB,OAAShB,OAAAA,QAAAC,QAAA1B,EACvC,WAAA,OAAAyB,QAAAC,QACgBC,MAEhB,kDAAA,CACEC,OAAQ,OACRC,QAASpB,EAAKU,eACdlB,KAAM6B,KAAKC,UAAU,CACnBC,aAAY,KAAOR,EACnBiB,KAAMA,EAAKC,mBAGhBrC,KAVK6B,SAAAA,UAAGT,QAAAC,QAWUQ,EAAIC,QAAM9B,KAAvB8B,SAAAA,OAAIQ,EAIV,OAHQ,MAAJR,GAAAQ,OAAIA,EAAJR,EAAMS,iBAAND,EAAsBrC,QACxBG,EAAKa,UAAYa,EAAKS,eAAetC,OAEhC6B,CAAK,EACd,EAAA,WAASC,GAEP,MADAC,QAAQC,MAAMF,GACR,IAAI5C,EAAiB,2BAC7B,GACF,CAAC,MAAAY,UAAAqB,QAAAc,OAAAnC,EAQDyC,CAAAA,EAAAA,KAAAA,OAAgBC,SAAAA,EAAKC,GAAc,IACjC,GAAID,EAAM,GACR,MAAU,IAAAtD,EAAiB,qCAC5B,OAAAiC,QAAAC,QAAA1B,EACG,WAAA,OAAAyB,QAAAC,QACgBC,MAEhB,oDAAA,CACEC,OAAQ,OACRC,QAASnB,EAAKS,eACdlB,KAAM6B,KAAKC,UAAU,CACnBe,IAAKE,OAAOF,GACZG,gBAAiBF,OAGtB1C,cAVK6B,GAAG,OAAAT,QAAAC,QAWUQ,EAAIC,QAAM9B,KAAvB8B,SAAAA,GAIN,OAHIA,EAAK7B,QACPI,EAAKY,UAAYa,EAAK7B,OAEjB6B,CAAK,EAAA,EACd,EAAC,SAAQC,GAEP,MADAC,QAAQC,MAAMF,GACJ,IAAA5C,EAAiB,2BAC7B,GACF,CAAC,MAAAY,GAAAqB,OAAAA,QAAAc,OAAAnC,UAQD8C,cAAa,SAAUC,GAAU,IAC/B,IAAKxC,EAAKW,UACR,MAAU,IAAA9B,EAAiB,8BAC5B,OAAAiC,QAAAC,QAAA1B,EACG,WAAA,OAAAyB,QAAAC,QACgBC,MAAK,mDAErB,CACEC,OAAQ,OACRC,QAAOuB,EACFzC,CAAAA,EAAAA,EAAKQ,eAAc,CACtBkC,cAAa,UAAY1C,EAAKW,YAEhCrB,KAAM6B,KAAKC,UAAU,CACnBoB,MAAOA,OAGZ9C,cAZK6B,GAAG,OAAAT,QAAAC,QAaUQ,EAAIC,QAAM9B,KAAvB8B,SAAAA,GACN,GAAIA,EAAKzC,QACP,MAAU,IAAAF,EAAiB2C,EAAKzC,SAElC,OAAOyC,CAAK,EACd,EAAA,EAAc,WAEZ,MADAE,QAAQC,MAAMA,OACJ,IAAA9C,EAAiB,wCAC7B,GACF,CAAC,MAAAY,GAAA,OAAAqB,QAAAc,OAAAnC,EAAA,CAAA,EAAAI,KAMD8C,uBAAqC,WAAA,IACnC,IAAK1C,EAAKU,UACR,MAAU,IAAA9B,EAAiB,8BAC5B,OAAAiC,QAAAC,QAAA1B,EACG,WAAA,OAAAyB,QAAAC,QACgBC,MAEhB,yDAAA,CACEC,OAAQ,MACRC,QAAOuB,EACFxC,CAAAA,EAAAA,EAAKO,eACRkC,CAAAA,wBAAyBzC,EAAKU,eAGnCjB,KATK6B,SAAAA,GAAGT,OAAAA,QAAAC,QAUUQ,EAAIC,QAAM9B,KAAA,SAAvB8B,GAAI,GACNA,EAAKoB,gCACP,OAAOpB,EAAKoB,gCAEZ,MAAM,IAAI/D,SAAiB2C,SAAAA,EAAMzC,UAAW,yBAA0B,EAAA,EAE1E,EAAC,WAEC,MADA2C,QAAQC,MAAMA,OACJ,IAAA9C,EAAiB,yBAC7B,GACF,CAAC,MAAAY,GAAAqB,OAAAA,QAAAc,OAAAnC,UAODoD,YAAW,SAAUC,GAAa,IAChC,IAAK5C,EAAKS,UACR,MAAU,IAAA9B,EAAiB,8BAC5B,OAAAiC,QAAAC,QAAA1B,EACG,WAAA,OAAAyB,QAAAC,QACgBC,MAAK,oDAErB,CACEC,OAAQ,OACRC,QAAOuB,EACFvC,CAAAA,EAAAA,EAAKM,eAAc,CACtBkC,cAAa,UAAYxC,EAAKS,YAEhCrB,KAAM6B,KAAKC,UAAU,CACnB2B,WAAY,UACZC,UAAW,yBACXC,aAAcH,OAGnBpD,cAdK6B,GAAG,OAAAT,QAAAC,QAeUQ,EAAIC,QAAM9B,KAAvB8B,SAAAA,UAAIV,QAAAC,QACJmC,aAAaC,QAAQ,WAAYL,IAASpD,KAAA,WAChD,OAAO8B,CAAK,EACd,EAAA,EAAA,EAASC,SAAAA,GAEP,MADAC,QAAQC,MAAMF,GACR,IAAI5C,EAAiB,2BAC7B,GACF,CAAC,MAAAY,GAAA,OAAAqB,QAAAc,OAAAnC,EAOD2D,CAAAA,EAAAA,KAAAA,yBAAyBC,QAAAA,IAAAA,IAAAA,EAAU,IAAO,IACxC,IAAKlD,EAAKQ,UACR,MAAM,IAAI9B,EAAiB,8BAC5B,OAAAiC,QAAAC,QAAA1B,EAAA,WACGyB,OAAAA,QAAAC,QACgBC,MAAK,gDAC2BqC,EAChD,CACEpC,OAAQ,MACRC,QAAOuB,KACFtC,EAAKK,eACRkC,CAAAA,wBAAyBvC,EAAKQ,eAGnCjB,KAAA,SATK6B,GAAGT,OAAAA,QAAAC,QAUUQ,EAAIC,OAEzB,EAAA,WAASC,GAEP,MADAC,QAAQC,MAAMF,GACR,IAAI5C,EAAgB,kCAC5B,GACF,CAAC,MAAAY,GAAA,OAAAqB,QAAAc,OAAAnC,EAAA,CAAA,EAAAI,KAUDyD,cAAuBD,SAAAA,EAASE,EAAkBC,QAAV,IAARD,IAAAA,EAAW,OAAK,IAC9C,IAAKnD,EAAKO,UACR,MAAM,IAAI9B,EAAiB,8BAC5B,OAAAiC,QAAAC,QAAA1B,EAAA,kBACGyB,QAAAC,QACgBC,MAC8BqC,8CAAAA,EAAgBE,SAAAA,GAC5DC,EAAS,WAAaA,EAAS,IAEjC,CACEvC,OAAQ,MACRC,QAAOuB,EACFrC,CAAAA,EAAAA,EAAKI,eAAc,CACtBkC,cAAa,UAAYtC,EAAKO,eAGnCjB,cAXK6B,GAAG,OAAAT,QAAAC,QAYUQ,EAAIC,OAAM,EAE/B,EAASC,SAAAA,GAEP,MADAC,QAAQC,MAAMF,OACJ5C,EAAkD,kCAC9D,GACF,CAAC,MAAAY,GAAAqB,OAAAA,QAAAc,OAAAnC,EAAA,CAAA,EAAAI,KAQD4D,QAAO,SAAUC,EAAQC,GAAW,IAClC,IAAKtD,EAAKM,UACR,MAAU,IAAA9B,EAAiB,8BAC5B,OAAAiC,QAAAC,QAAA1B,EACG,WAAA,OAAAyB,QAAAC,QACgBC,MAAK,6CAA+C,CACpEC,OAAQ,OACRC,QAAOuB,EACFpC,CAAAA,EAAAA,EAAKG,eAAc,CACtBkC,cAAyBrC,UAAAA,EAAKM,YAEhCrB,KAAM6B,KAAKC,UAAU,CACnBwC,QAASF,EACTG,YAAaF,OAEfjE,KAVI6B,SAAAA,GAAGT,OAAAA,QAAAC,QAWUQ,EAAIC,SAEzB,EAAC,SAAQC,GAEP,MADAC,QAAQC,MAAMF,OACJ5C,EAAqD,qCACjE,GACF,CAAC,MAAAY,UAAAqB,QAAAc,OAAAnC,EAQDqE,CAAAA,EAAAA,KAAAA,gBAAyBJ,SAAAA,OACvB,IAAKpD,EAAKK,UACR,MAAM,IAAI9B,EAAiB,8BAC5B,OAAAiC,QAAAC,QAAA1B,EAAA,WACGyB,OAAAA,QAAAC,QACgBC,MACuC0C,uDAAAA,EACvD,CACEzC,OAAQ,MACRC,QAAOuB,EAAA,CAAA,EACFnC,EAAKE,gBACRkC,cAAa,UAAYpC,EAAKK,eAGnCjB,KATK6B,SAAAA,GAYN,SAASwC,EAAmBC,GAE1B,IAAMC,EAAa,IAAIC,IAEjBC,EAAmB,GAuBzB,OApBAH,EAAYI,QAAQ,SAACC,GAEnBJ,EAAWK,IAAID,EAAQE,GAAIF,GAE3B,IAAMG,EAAgBP,EAAWQ,IAAIJ,EAAQK,eAG1CF,GACDH,EAAQK,gBAAkBL,EAAQM,gBAM7BH,EAAcI,UAASJ,EAAcI,QAAU,IACpDJ,EAAcI,QAAQC,KAAKR,IAJ3BF,EAAiBU,KAAKR,EAM1B,GAGOS,EAAgBX,EACzB,CAGA,SAASW,EAAgBC,GAEvB,OAAOA,EAASC,OAAO,SAACC,EAAcZ,GAOpC,OALAY,EAAaJ,KAAKR,GAEdA,EAAQO,SACVK,EAAaJ,KAAIK,MAAjBD,EAAqBH,EAAgBT,EAAQO,UAExCK,CACT,EAAG,GACL,CAAC,OAAAnE,QAAAC,QA5CkBQ,EAAIC,QAAM9B,KAAA,SAAvB8B,GA+CN,OADuBuC,EAAmBvC,EAAK2D,MACzB,EACxB,EAAA,WAAS1D,GAEP,MADAC,QAAQC,MAAMF,GACR,IAAI5C,EAAgB,kCAC5B,GACF,CAAC,MAAAY,GAAA,OAAAqB,QAAAc,OAAAnC,EAAA,CAAA,EAAAI,KAODuF,mBAAiC,WAAA,IAC/B,IAAK7E,EAAKI,UACR,MAAM,IAAI9B,EAAiB,8BAC5B,OAAAiC,QAAAC,QAAA1B,aACGyB,OAAAA,QAAAC,QACgBC,MAAK,6CAA+C,CACpEC,OAAQ,MACRC,QAAOuB,KACFlC,EAAKC,eAAc,CACtBkC,cAAa,UAAYnC,EAAKI,eAEhCjB,KAAA,SANI6B,GAAG,OAAAT,QAAAC,QAOUQ,EAAIC,QAAM9B,KAAvB8B,SAAAA,GAAIV,OAAAA,QAAAC,QACGS,EAAK6D,WACpB,EAAC,SAAQ5D,GAEP,MADAC,QAAQC,MAAMF,GACJ,IAAA5C,EAAgB,qCAC5B,GACF,CAAC,MAAAY,GAAAqB,OAAAA,QAAAc,OAAAnC,EAAA,CAAA,EArYKE,IACFE,KAAKc,UAAYhB,EAErB"}
@@ -0,0 +1,229 @@
1
+ /**
2
+ * Create a new instance of the API client
3
+ * @param [token] - user bearer token
4
+ */
5
+ declare class SidechatAPIClient {
6
+ constructor(token?: SidechatAuthToken);
7
+ /**
8
+ * User bearer token
9
+ */
10
+ userToken: SidechatAuthToken;
11
+ /**
12
+ * Default headers for every API request
13
+ */
14
+ defaultHeaders: any;
15
+ /**
16
+ * 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
17
+ * @param token - user bearer token
18
+ */
19
+ setToken(token: SidechatAuthToken): void;
20
+ /**
21
+ * Initiate the login process with a phone number. Should be followed up with verifySMSCode().
22
+ * @param phoneNumber - US phone number (WITHOUT +1) to send verification code to
23
+ */
24
+ loginViaSMS(phoneNumber: number): void;
25
+ /**
26
+ * Verify the code sent via SMS with loginViaSMS().
27
+ * @param phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
28
+ * @param code - the verification code
29
+ */
30
+ verifySMSCode(phoneNumber: number, code: string): void;
31
+ /**
32
+ * Set the user's age
33
+ * @param age - user's age in years
34
+ * @param registrationID - the registration ID generated by verifySMSCode()
35
+ */
36
+ setAge(age: number, registrationID: string): void;
37
+ /**
38
+ * Initiate the email setup process. Should be followed up with checkEmailVerification().
39
+ * @param email - school email address to send verification code to
40
+ */
41
+ registerEmail(email: string): void;
42
+ /**
43
+ * Check is the user's email is verified.
44
+ */
45
+ checkEmailVerification(): void;
46
+ /**
47
+ * Set the device ID of the current user
48
+ * @param deviceId - the device ID to set
49
+ */
50
+ setDeviceID(deviceId: string): void;
51
+ /**
52
+ * Get updated status for user and group
53
+ * @param [groupID] - ID of a specific group to retrieve info from
54
+ */
55
+ getUserAndGroup(groupID?: string): void;
56
+ /**
57
+ * Fetches posts from the specified category in a group
58
+ * @param groupID - group ID
59
+ * @param category - category to filter posts
60
+ * @param [cursor] - cursor string
61
+ * @returns List of posts and cursor
62
+ */
63
+ getGroupPosts(groupID: string, category: "hot" | "recent" | "top", cursor?: SidechatCursorString): SidechatPostsAndCursor;
64
+ /**
65
+ * Upvote or downvote, or unvote a post
66
+ * @param postID - post ID to vote on
67
+ * @param action - whether to upvote, downvote, or reset vote
68
+ */
69
+ setVote(postID: string, action: SidechatVoteString): void;
70
+ /**
71
+ * Get all the commments on a post
72
+ * @param postID - post ID to get comments for
73
+ * @returns list of comments
74
+ */
75
+ getPostComments(postID: string): SidechatPostOrComment[];
76
+ /**
77
+ * Gets groups to be displayed on the "Explore Groups" page
78
+ */
79
+ getAvailableGroups(): SidechatGroup[];
80
+ }
81
+
82
+ /**
83
+ * Throwable error caused by the Sidechat API
84
+ */
85
+ declare class SidechatAPIError extends Error {
86
+ }
87
+
88
+ /**
89
+ * A user-created post or comment, depending on the "type" prop
90
+ * @property type - whether this object represents a post or a comment on a post
91
+ * @property id - alphanumeric ID of post or comment
92
+ * @property authored_by_user - undocumented
93
+ * @property alias - post creator's name in-app
94
+ * @property group_id - alphanumeric ID of group
95
+ * @property group - group in which post or comment was created
96
+ * @property text - text content of post or comment
97
+ * @property created_at - date string of post or comment creation time
98
+ * @property vote_total - sum of upvotes and downvotes
99
+ * @property vote_status - current user's vote on post or comment
100
+ * @property assets - array of assets attached to post or comment
101
+ * @property attachments - undocumented
102
+ * @property dms_disabled - whether or not you can send a DM to creator of post
103
+ * @property tags - undocumented
104
+ * @property identity - creator's identity information
105
+ * @property pinned - undocumented
106
+ * @property is_saved - undocumented
107
+ * @property follow_status - undocumented
108
+ * @property [destination] - undocumented
109
+ * @property [comment_count] - number of comments on post (only if type=post)
110
+ * @property [comments_disabled] - whether or not you can comment on post (only if type=post)
111
+ * @property [parent_post_id] - alphanumeric ID of parent post (only if type=comment)
112
+ * @property [reply_post_id] - alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
113
+ * @property [context] - text content of comment being replied to, falls back to text (only if type=comment)
114
+ */
115
+ declare type SidechatPostOrComment = {
116
+ type: "post" | "comment";
117
+ id: string;
118
+ authored_by_user: boolean;
119
+ alias: string;
120
+ group_id: string;
121
+ group: SidechatGroup;
122
+ text: string;
123
+ created_at: string;
124
+ vote_total: number;
125
+ vote_status: SidechatVoteString;
126
+ assets: SidechatAsset[];
127
+ attachments: any[];
128
+ dms_disabled: boolean;
129
+ tags: any[];
130
+ identity: SidechatIdentity;
131
+ pinned: boolean;
132
+ is_saved: boolean;
133
+ follow_status: "following" | "not_following";
134
+ destination?: "group";
135
+ comment_count?: number;
136
+ comments_disabled?: boolean;
137
+ parent_post_id?: string;
138
+ reply_post_id?: string;
139
+ context?: string;
140
+ };
141
+
142
+ /**
143
+ * A group object, containing metadata about a group as well as its join conditions and states
144
+ * @property id - alphanumeric ID of group
145
+ * @property name - human-readable name of group
146
+ * @property analytics_name - name to file group under
147
+ * @property membership_type - whether or not current user is a member of group
148
+ * @property color - group's theme color as hex code (e.g., #FFFFFF)
149
+ * @property group_join_type - basis on which group accepts new members
150
+ * @property group_visibility - group's visibility setting
151
+ * @property asset_library_visibility - whether or not group's asset library is visible
152
+ * @property [roles] - undocumented
153
+ * @property [description] - description of group
154
+ * @property [icon_url] - image URL for group icon
155
+ * @property [member_count] - number of users in group
156
+ * @property [should_show_leaderboard] - undocumented
157
+ */
158
+ declare type SidechatGroup = {
159
+ id: string;
160
+ name: string;
161
+ analytics_name: string;
162
+ membership_type: "non_member" | "member";
163
+ color: string;
164
+ group_join_type: "open" | "closed" | "email_domain";
165
+ group_visibility: "private" | "public_to_all" | "public_to_schools";
166
+ asset_library_visibility: "show" | "hide";
167
+ roles?: any[];
168
+ description?: string;
169
+ icon_url?: SidechatPrivateAssetURL;
170
+ member_count?: number;
171
+ should_show_leaderboard?: boolean;
172
+ };
173
+
174
+ /**
175
+ * An asset object, containing information about an image within a post or comment
176
+ * @property id - alphanumeric ID of asset
177
+ * @property type - undocumented
178
+ * @property content_type - file type of asset
179
+ * @property width - the width of asset
180
+ * @property height - the height of asset
181
+ * @property url - URL string of asset's location
182
+ */
183
+ declare type SidechatAsset = {
184
+ id: string;
185
+ type: "image";
186
+ content_type: "jpeg" | "png" | "gif";
187
+ width: number;
188
+ height: number;
189
+ url: SidechatPrivateAssetURL;
190
+ };
191
+
192
+ /**
193
+ * A user's identity information
194
+ * @property name - representation of user's name (varies across app)
195
+ * @property posted_with_username - undocumented
196
+ */
197
+ declare type SidechatIdentity = {
198
+ name: string;
199
+ posted_with_username: boolean;
200
+ };
201
+
202
+ /**
203
+ * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
204
+ */
205
+ declare type SidechatPrivateAssetURL = string;
206
+
207
+ /**
208
+ * A cursor for paginating through post lists
209
+ */
210
+ declare type SidechatCursorString = string;
211
+
212
+ /**
213
+ * A vote on a comment or post
214
+ */
215
+ declare type SidechatVoteString = "upvote" | "downvote" | "none";
216
+
217
+ /**
218
+ * A user's bearer authentication token needed for most requests
219
+ */
220
+ declare type SidechatAuthToken = string;
221
+
222
+ /**
223
+ * A list of posts and the associated cursor
224
+ */
225
+ declare type SidechatPostsAndCursor = {
226
+ posts: SidechatPostOrComment[];
227
+ cursor: SidechatCursorString;
228
+ };
229
+
@@ -0,0 +1,3 @@
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#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><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-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#line169">line 169</a></li></ul></dd></div></dl><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-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#line401">line 401</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-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#line266">line 266</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-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#line327">line 327</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-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#line235">line 235</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-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#line49">line 49</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-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#line136">line 136</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</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-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#line103">line 103</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-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#line201">line 201</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-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#line297">line 297</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().</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-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#line73">line 73</a></li></ul></dd></div></dl></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAsset">SidechatAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
@@ -0,0 +1,3 @@
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#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><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#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>