musora-content-services 2.92.3 → 2.92.6

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 (114) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +1 -1
  3. package/src/index.d.ts +2 -0
  4. package/src/index.js +2 -0
  5. package/src/services/content-org/learning-paths.ts +3 -3
  6. package/src/services/progress-row/method-card.js +1 -1
  7. package/src/services/sync/fetch.ts +3 -0
  8. package/docs/Content.html +0 -269
  9. package/docs/ContentOrganization.html +0 -245
  10. package/docs/Forums.html +0 -269
  11. package/docs/Gamification.html +0 -245
  12. package/docs/TestUser.html +0 -260
  13. package/docs/UserManagementSystem.html +0 -317
  14. package/docs/api_types.js.html +0 -97
  15. package/docs/config.js.html +0 -140
  16. package/docs/content-org_content-org.js.html +0 -76
  17. package/docs/content-org_guided-courses.ts.html +0 -110
  18. package/docs/content-org_learning-paths.ts.html +0 -391
  19. package/docs/content-org_playlists-types.js.html +0 -128
  20. package/docs/content-org_playlists.js.html +0 -440
  21. package/docs/content.js.html +0 -603
  22. package/docs/content_artist.ts.html +0 -206
  23. package/docs/content_content.ts.html +0 -77
  24. package/docs/content_genre.ts.html +0 -209
  25. package/docs/content_instructor.ts.html +0 -206
  26. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  27. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  28. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  29. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  30. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  31. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  32. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  33. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  34. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  35. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -978
  36. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  37. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  38. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  39. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  40. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -1049
  41. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  42. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  43. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  44. package/docs/forums_categories.ts.html +0 -156
  45. package/docs/forums_discussions.js.html +0 -95
  46. package/docs/forums_forum.js.html +0 -95
  47. package/docs/forums_forums.ts.html +0 -160
  48. package/docs/forums_posts.ts.html +0 -284
  49. package/docs/forums_threads.ts.html +0 -284
  50. package/docs/gamification_awards.js.html +0 -165
  51. package/docs/gamification_awards.ts.html +0 -195
  52. package/docs/gamification_gamification.js.html +0 -76
  53. package/docs/gamification_types.js.html +0 -80
  54. package/docs/global.html +0 -6019
  55. package/docs/index.html +0 -167
  56. package/docs/liveTesting.ts.html +0 -103
  57. package/docs/module-Accounts.html +0 -2283
  58. package/docs/module-Artist.html +0 -993
  59. package/docs/module-Awards.html +0 -836
  60. package/docs/module-Categories.html +0 -711
  61. package/docs/module-Config.html +0 -431
  62. package/docs/module-Content-Services-V2.html +0 -2998
  63. package/docs/module-ForumCategories.html +0 -687
  64. package/docs/module-ForumDiscussions.html +0 -370
  65. package/docs/module-Forums.html +0 -16599
  66. package/docs/module-Genre.html +0 -981
  67. package/docs/module-GuidedCourses.html +0 -108
  68. package/docs/module-Instructor.html +0 -929
  69. package/docs/module-Interests.html +0 -1066
  70. package/docs/module-LearningPaths.html +0 -2424
  71. package/docs/module-Onboarding.html +0 -882
  72. package/docs/module-Payments.html +0 -392
  73. package/docs/module-Permissions.html +0 -406
  74. package/docs/module-Playlists.html +0 -3030
  75. package/docs/module-ProgressRow.html +0 -108
  76. package/docs/module-Railcontent-Services.html +0 -5876
  77. package/docs/module-Sanity-Services.html +0 -8244
  78. package/docs/module-Sessions.html +0 -575
  79. package/docs/module-Threads.html +0 -1119
  80. package/docs/module-UserActivity.html +0 -4534
  81. package/docs/module-UserChat.html +0 -410
  82. package/docs/module-UserManagement.html +0 -1932
  83. package/docs/module-UserMemberships.html +0 -829
  84. package/docs/module-UserNotifications.html +0 -2595
  85. package/docs/module-UserProfile.html +0 -370
  86. package/docs/progress-row_method-card.js.html +0 -184
  87. package/docs/railcontent.js.html +0 -724
  88. package/docs/sanity.js.html +0 -2322
  89. package/docs/scripts/collapse.js +0 -39
  90. package/docs/scripts/commonNav.js +0 -28
  91. package/docs/scripts/linenumber.js +0 -25
  92. package/docs/scripts/nav.js +0 -12
  93. package/docs/scripts/polyfill.js +0 -4
  94. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
  95. package/docs/scripts/prettify/lang-css.js +0 -2
  96. package/docs/scripts/prettify/prettify.js +0 -28
  97. package/docs/scripts/search.js +0 -99
  98. package/docs/styles/jsdoc.css +0 -776
  99. package/docs/styles/prettify.css +0 -80
  100. package/docs/userActivity.js.html +0 -1512
  101. package/docs/user_account.ts.html +0 -265
  102. package/docs/user_chat.js.html +0 -98
  103. package/docs/user_interests.js.html +0 -150
  104. package/docs/user_management.js.html +0 -258
  105. package/docs/user_memberships.js.html +0 -144
  106. package/docs/user_memberships.ts.html +0 -292
  107. package/docs/user_notifications.js.html +0 -374
  108. package/docs/user_onboarding.ts.html +0 -329
  109. package/docs/user_payments.ts.html +0 -146
  110. package/docs/user_permissions.js.html +0 -110
  111. package/docs/user_profile.js.html +0 -115
  112. package/docs/user_sessions.js.html +0 -170
  113. package/docs/user_types.js.html +0 -224
  114. package/docs/user_user-management-system.js.html +0 -79
@@ -1,1932 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>UserManagement - Documentation</title>
7
-
8
-
9
- <script src="scripts/prettify/prettify.js"></script>
10
- <script src="scripts/prettify/lang-css.js"></script>
11
- <!--[if lt IE 9]>
12
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
- <![endif]-->
14
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
- <script src="scripts/nav.js" defer></script>
17
-
18
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
- </head>
20
- <body>
21
-
22
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
- <label for="nav-trigger" class="navicon-button x">
24
- <div class="navicon"></div>
25
- </label>
26
-
27
- <label for="nav-trigger" class="overlay"></label>
28
-
29
- <nav >
30
-
31
-
32
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li><li data-type='method'><a href="module-Accounts.html#~toggleStudentView">toggleStudentView</a></li></ul></li><li><a href="module-Artist.html">Artist</a><ul class='methods'><li data-type='method'><a href="module-Artist.html#~fetchArtistBySlug">fetchArtistBySlug</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtists">fetchArtists</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getOwnedContent">getOwnedContent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deleteForumCategory">deleteForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~markThreadAsRead">markThreadAsRead</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-Genre.html">Genre</a><ul class='methods'><li data-type='method'><a href="module-Genre.html#~fetchGenreBySlug">fetchGenreBySlug</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenres">fetchGenres</a></li></ul></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Instructor.html">Instructor</a><ul class='methods'><li data-type='method'><a href="module-Instructor.html#~fetchInstructorBySlug">fetchInstructorBySlug</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructorLessons">fetchInstructorLessons</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructors">fetchInstructors</a></li></ul></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-LearningPaths.html">LearningPaths</a><ul class='methods'><li data-type='method'><a href="module-LearningPaths.html#~completeLearningPathIntroVideo">completeLearningPathIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~completeMethodIntroVideo">completeMethodIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathProgressCheckLessons">fetchLearningPathProgressCheckLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~getEnrichedLearningPath">getEnrichedLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getLearningPathLessonsByIds">getLearningPathLessonsByIds</a></li><li data-type='method'><a href="module-LearningPaths.html#~mapContentToParent">mapContentToParent</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-ProgressRow.html">ProgressRow</a></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2StructureFromId">fetchMethodV2StructureFromId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOwnedContent">fetchOwnedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchTopLevelParentId">fetchTopLevelParentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
33
-
34
- </nav>
35
-
36
- <div id="main">
37
-
38
- <h1 class="page-title">UserManagement</h1>
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
- <section>
47
-
48
- <header>
49
-
50
-
51
-
52
- </header>
53
-
54
- <article>
55
-
56
- <div class="container-overview">
57
-
58
-
59
-
60
-
61
-
62
- </div>
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
- <h3 class="subsection-title">Methods</h3>
81
-
82
-
83
-
84
-
85
-
86
-
87
- <h4 class="name" id=".blockUser"><span class="type-signature type-signature-static">(static) </span>blockUser<span class="signature">(userId)</span><span class="type-signature"> &rarr; {Promise.&lt;(any|string|null)>}</span></h4>
88
-
89
-
90
-
91
-
92
-
93
-
94
- <dl class="details">
95
-
96
- <dt class="tag-description">Description:</dt>
97
- <dd class="tag-description"><ul class="dummy"><li>Block the provided user</li></ul></dd>
98
-
99
-
100
-
101
- <dt class="tag-source">Source:</dt>
102
- <dd class="tag-source"><ul class="dummy"><li>
103
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line27">line 27</a>
104
- </li></ul></dd>
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
- </dl>
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
- <h5 class="h5-parameters">Parameters:</h5>
151
-
152
-
153
- <table class="params">
154
- <thead>
155
- <tr>
156
-
157
- <th>Name</th>
158
-
159
-
160
- <th>Type</th>
161
-
162
-
163
-
164
-
165
-
166
- <th class="last">Description</th>
167
- </tr>
168
- </thead>
169
-
170
- <tbody>
171
-
172
-
173
- <tr>
174
-
175
- <td class="name"><code>userId</code></td>
176
-
177
-
178
- <td class="type">
179
-
180
- </td>
181
-
182
-
183
-
184
-
185
-
186
- <td class="description last"></td>
187
- </tr>
188
-
189
-
190
- </tbody>
191
- </table>
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
- <h5 class="h5-returns">Returns:</h5>
209
-
210
-
211
-
212
-
213
- <dl class="param-type">
214
- <dt>
215
- Type
216
- </dt>
217
- <dd>
218
-
219
- <span class="param-type">Promise.&lt;(any|string|null)></span>
220
-
221
-
222
-
223
- </dd>
224
- </dl>
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
- <h4 class="name" id=".blockedUsers"><span class="type-signature type-signature-static">(static) </span>blockedUsers<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="global.html#BlockedUsersDTO">BlockedUsersDTO</a>>>}</span></h4>
236
-
237
-
238
-
239
-
240
-
241
-
242
- <dl class="details">
243
-
244
- <dt class="tag-description">Description:</dt>
245
- <dd class="tag-description"><ul class="dummy"><li>Fetches the blocked users for the current user.</li></ul></dd>
246
-
247
-
248
-
249
- <dt class="tag-source">Source:</dt>
250
- <dd class="tag-source"><ul class="dummy"><li>
251
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line16">line 16</a>
252
- </li></ul></dd>
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
- </dl>
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
- <h5 class="h5-returns">Returns:</h5>
313
-
314
-
315
-
316
-
317
- <dl class="param-type">
318
- <dt>
319
- Type
320
- </dt>
321
- <dd>
322
-
323
- <span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#BlockedUsersDTO">BlockedUsersDTO</a>>></span>
324
-
325
-
326
-
327
- </dd>
328
- </dl>
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
- <h4 class="name" id=".deletePicture"><span class="type-signature type-signature-static">(static) </span>deletePicture<span class="signature">(pictureUrl)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>
340
-
341
-
342
-
343
-
344
-
345
-
346
- <dl class="details">
347
-
348
-
349
-
350
- <dt class="tag-source">Source:</dt>
351
- <dd class="tag-source"><ul class="dummy"><li>
352
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line112">line 112</a>
353
- </li></ul></dd>
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
- </dl>
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
- <h5 class="h5-parameters">Parameters:</h5>
400
-
401
-
402
- <table class="params">
403
- <thead>
404
- <tr>
405
-
406
- <th>Name</th>
407
-
408
-
409
- <th>Type</th>
410
-
411
-
412
-
413
-
414
-
415
- <th class="last">Description</th>
416
- </tr>
417
- </thead>
418
-
419
- <tbody>
420
-
421
-
422
- <tr>
423
-
424
- <td class="name"><code>pictureUrl</code></td>
425
-
426
-
427
- <td class="type">
428
-
429
-
430
- <span class="param-type">string</span>
431
-
432
-
433
-
434
-
435
- </td>
436
-
437
-
438
-
439
-
440
-
441
- <td class="description last"></td>
442
- </tr>
443
-
444
-
445
- </tbody>
446
- </table>
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
- <h5 class="h5-returns">Returns:</h5>
464
-
465
-
466
-
467
-
468
- <dl class="param-type">
469
- <dt>
470
- Type
471
- </dt>
472
- <dd>
473
-
474
- <span class="param-type">Promise.&lt;any></span>
475
-
476
-
477
-
478
- </dd>
479
- </dl>
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
- <h4 class="name" id=".getUserData"><span class="type-signature type-signature-static">(static) </span>getUserData<span class="signature">(userId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="global.html#User">User</a>|null)>}</span></h4>
491
-
492
-
493
-
494
-
495
-
496
-
497
- <dl class="details">
498
-
499
-
500
-
501
- <dt class="tag-source">Source:</dt>
502
- <dd class="tag-source"><ul class="dummy"><li>
503
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line124">line 124</a>
504
- </li></ul></dd>
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
- </dl>
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
- <h5 class="h5-parameters">Parameters:</h5>
551
-
552
-
553
- <table class="params">
554
- <thead>
555
- <tr>
556
-
557
- <th>Name</th>
558
-
559
-
560
- <th>Type</th>
561
-
562
-
563
- <th>Attributes</th>
564
-
565
-
566
-
567
- <th>Default</th>
568
-
569
-
570
- <th class="last">Description</th>
571
- </tr>
572
- </thead>
573
-
574
- <tbody>
575
-
576
-
577
- <tr>
578
-
579
- <td class="name"><code>userId</code></td>
580
-
581
-
582
- <td class="type">
583
-
584
-
585
- <span class="param-type">number</span>
586
-
587
-
588
-
589
-
590
- </td>
591
-
592
-
593
- <td class="attributes">
594
-
595
- &lt;optional><br>
596
-
597
-
598
-
599
-
600
-
601
- </td>
602
-
603
-
604
-
605
- <td class="default">
606
-
607
- <code>globalConfig.sessionConfig.userId</code>
608
-
609
- </td>
610
-
611
-
612
- <td class="description last"></td>
613
- </tr>
614
-
615
-
616
- </tbody>
617
- </table>
618
-
619
-
620
-
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
- <h5 class="h5-returns">Returns:</h5>
635
-
636
-
637
-
638
-
639
- <dl class="param-type">
640
- <dt>
641
- Type
642
- </dt>
643
- <dd>
644
-
645
- <span class="param-type">Promise.&lt;(<a href="global.html#User">User</a>|null)></span>
646
-
647
-
648
-
649
- </dd>
650
- </dl>
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
-
659
-
660
-
661
- <h4 class="name" id=".getUserSignature"><span class="type-signature type-signature-static">(static) </span>getUserSignature<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;{signature: string}>}</span></h4>
662
-
663
-
664
-
665
-
666
-
667
-
668
- <dl class="details">
669
-
670
- <dt class="tag-description">Description:</dt>
671
- <dd class="tag-description"><ul class="dummy"><li>Retrieves the current signature for the authenticated user.</li></ul></dd>
672
-
673
-
674
-
675
- <dt class="tag-source">Source:</dt>
676
- <dd class="tag-source"><ul class="dummy"><li>
677
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line167">line 167</a>
678
- </li></ul></dd>
679
-
680
-
681
-
682
-
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
-
709
-
710
- </dl>
711
-
712
-
713
-
714
-
715
-
716
-
717
-
718
-
719
-
720
-
721
-
722
-
723
-
724
-
725
-
726
-
727
-
728
-
729
-
730
-
731
-
732
-
733
-
734
-
735
-
736
-
737
-
738
- <h5 class="h5-returns">Returns:</h5>
739
-
740
-
741
- <div class="param-desc">
742
- - A promise that resolves with the user's current signature data.
743
- </div>
744
-
745
-
746
-
747
- <dl class="param-type">
748
- <dt>
749
- Type
750
- </dt>
751
- <dd>
752
-
753
- <span class="param-type">Promise.&lt;{signature: string}></span>
754
-
755
-
756
-
757
- </dd>
758
- </dl>
759
-
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
-
769
- <h4 class="name" id=".isUsernameAvailable"><span class="type-signature type-signature-static">(static) </span>isUsernameAvailable<span class="signature">(userName)</span><span class="type-signature"> &rarr; {Promise.&lt;{available: boolean}>}</span></h4>
770
-
771
-
772
-
773
-
774
-
775
-
776
- <dl class="details">
777
-
778
-
779
-
780
- <dt class="tag-source">Source:</dt>
781
- <dd class="tag-source"><ul class="dummy"><li>
782
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line134">line 134</a>
783
- </li></ul></dd>
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
-
793
-
794
-
795
-
796
-
797
-
798
-
799
-
800
-
801
-
802
-
803
-
804
-
805
-
806
-
807
-
808
-
809
-
810
-
811
-
812
-
813
-
814
-
815
- </dl>
816
-
817
-
818
-
819
-
820
-
821
-
822
-
823
-
824
-
825
-
826
-
827
-
828
-
829
- <h5 class="h5-parameters">Parameters:</h5>
830
-
831
-
832
- <table class="params">
833
- <thead>
834
- <tr>
835
-
836
- <th>Name</th>
837
-
838
-
839
- <th>Type</th>
840
-
841
-
842
-
843
-
844
-
845
- <th class="last">Description</th>
846
- </tr>
847
- </thead>
848
-
849
- <tbody>
850
-
851
-
852
- <tr>
853
-
854
- <td class="name"><code>userName</code></td>
855
-
856
-
857
- <td class="type">
858
-
859
- </td>
860
-
861
-
862
-
863
-
864
-
865
- <td class="description last">The display name to check for availability.</td>
866
- </tr>
867
-
868
-
869
- </tbody>
870
- </table>
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
- <h5 class="h5-returns">Returns:</h5>
888
-
889
-
890
- <div class="param-desc">
891
- - An object indicating if the display name is available.
892
- </div>
893
-
894
-
895
-
896
- <dl class="param-type">
897
- <dt>
898
- Type
899
- </dt>
900
- <dd>
901
-
902
- <span class="param-type">Promise.&lt;{available: boolean}></span>
903
-
904
-
905
-
906
- </dd>
907
- </dl>
908
-
909
-
910
-
911
-
912
-
913
-
914
-
915
-
916
-
917
-
918
- <h4 class="name" id=".setUserSignature"><span class="type-signature type-signature-static">(static) </span>setUserSignature<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;{signature: string}>}</span></h4>
919
-
920
-
921
-
922
-
923
-
924
-
925
- <dl class="details">
926
-
927
- <dt class="tag-description">Description:</dt>
928
- <dd class="tag-description"><ul class="dummy"><li>Updates the user's signature.</li></ul></dd>
929
-
930
-
931
-
932
- <dt class="tag-source">Source:</dt>
933
- <dd class="tag-source"><ul class="dummy"><li>
934
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line156">line 156</a>
935
- </li></ul></dd>
936
-
937
-
938
-
939
-
940
-
941
-
942
-
943
-
944
-
945
-
946
-
947
-
948
-
949
-
950
-
951
-
952
-
953
-
954
-
955
-
956
-
957
-
958
-
959
-
960
-
961
-
962
-
963
-
964
-
965
-
966
-
967
- </dl>
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
-
979
-
980
-
981
- <h5 class="h5-parameters">Parameters:</h5>
982
-
983
-
984
- <table class="params">
985
- <thead>
986
- <tr>
987
-
988
- <th>Name</th>
989
-
990
-
991
- <th>Type</th>
992
-
993
-
994
-
995
-
996
-
997
- <th class="last">Description</th>
998
- </tr>
999
- </thead>
1000
-
1001
- <tbody>
1002
-
1003
-
1004
- <tr>
1005
-
1006
- <td class="name"><code>params</code></td>
1007
-
1008
-
1009
- <td class="type">
1010
-
1011
-
1012
- <span class="param-type"><a href="global.html#SetUserSignatureParams">SetUserSignatureParams</a></span>
1013
-
1014
-
1015
-
1016
-
1017
- </td>
1018
-
1019
-
1020
-
1021
-
1022
-
1023
- <td class="description last">Parameters containing the user's signature.</td>
1024
- </tr>
1025
-
1026
-
1027
- </tbody>
1028
- </table>
1029
-
1030
-
1031
-
1032
-
1033
-
1034
-
1035
-
1036
-
1037
-
1038
-
1039
-
1040
-
1041
-
1042
-
1043
-
1044
-
1045
- <h5 class="h5-returns">Returns:</h5>
1046
-
1047
-
1048
- <div class="param-desc">
1049
- - A promise that resolves with the updated signature data.
1050
- </div>
1051
-
1052
-
1053
-
1054
- <dl class="param-type">
1055
- <dt>
1056
- Type
1057
- </dt>
1058
- <dd>
1059
-
1060
- <span class="param-type">Promise.&lt;{signature: string}></span>
1061
-
1062
-
1063
-
1064
- </dd>
1065
- </dl>
1066
-
1067
-
1068
-
1069
-
1070
-
1071
-
1072
-
1073
-
1074
-
1075
-
1076
- <h4 class="name" id=".toggleSignaturePrivate"><span class="type-signature type-signature-static">(static) </span>toggleSignaturePrivate<span class="signature">(showSignature<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;{show_signature: boolean}>}</span></h4>
1077
-
1078
-
1079
-
1080
-
1081
-
1082
-
1083
- <dl class="details">
1084
-
1085
- <dt class="tag-description">Description:</dt>
1086
- <dd class="tag-description"><ul class="dummy"><li>Toggles whether the user's signature is displayed publicly.</li></ul></dd>
1087
-
1088
-
1089
-
1090
- <dt class="tag-source">Source:</dt>
1091
- <dd class="tag-source"><ul class="dummy"><li>
1092
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line179">line 179</a>
1093
- </li></ul></dd>
1094
-
1095
-
1096
-
1097
-
1098
-
1099
-
1100
-
1101
-
1102
-
1103
-
1104
-
1105
-
1106
-
1107
-
1108
-
1109
-
1110
-
1111
-
1112
-
1113
-
1114
-
1115
-
1116
-
1117
-
1118
-
1119
-
1120
-
1121
-
1122
-
1123
-
1124
-
1125
- </dl>
1126
-
1127
-
1128
-
1129
-
1130
-
1131
-
1132
-
1133
-
1134
-
1135
-
1136
-
1137
-
1138
-
1139
- <h5 class="h5-parameters">Parameters:</h5>
1140
-
1141
-
1142
- <table class="params">
1143
- <thead>
1144
- <tr>
1145
-
1146
- <th>Name</th>
1147
-
1148
-
1149
- <th>Type</th>
1150
-
1151
-
1152
- <th>Attributes</th>
1153
-
1154
-
1155
-
1156
- <th>Default</th>
1157
-
1158
-
1159
- <th class="last">Description</th>
1160
- </tr>
1161
- </thead>
1162
-
1163
- <tbody>
1164
-
1165
-
1166
- <tr>
1167
-
1168
- <td class="name"><code>showSignature</code></td>
1169
-
1170
-
1171
- <td class="type">
1172
-
1173
-
1174
- <span class="param-type">boolean</span>
1175
-
1176
-
1177
-
1178
-
1179
- </td>
1180
-
1181
-
1182
- <td class="attributes">
1183
-
1184
- &lt;optional><br>
1185
-
1186
-
1187
-
1188
-
1189
-
1190
- </td>
1191
-
1192
-
1193
-
1194
- <td class="default">
1195
-
1196
- <code>true</code>
1197
-
1198
- </td>
1199
-
1200
-
1201
- <td class="description last">Whether to show (`true`) or hide (`false`) the user's signature.</td>
1202
- </tr>
1203
-
1204
-
1205
- </tbody>
1206
- </table>
1207
-
1208
-
1209
-
1210
-
1211
-
1212
-
1213
-
1214
-
1215
-
1216
-
1217
-
1218
-
1219
-
1220
-
1221
-
1222
-
1223
- <h5 class="h5-returns">Returns:</h5>
1224
-
1225
-
1226
- <div class="param-desc">
1227
- - A promise that resolves with the updated visibility state.
1228
- </div>
1229
-
1230
-
1231
-
1232
- <dl class="param-type">
1233
- <dt>
1234
- Type
1235
- </dt>
1236
- <dd>
1237
-
1238
- <span class="param-type">Promise.&lt;{show_signature: boolean}></span>
1239
-
1240
-
1241
-
1242
- </dd>
1243
- </dl>
1244
-
1245
-
1246
-
1247
-
1248
-
1249
-
1250
-
1251
-
1252
-
1253
-
1254
- <h4 class="name" id=".unblockUser"><span class="type-signature type-signature-static">(static) </span>unblockUser<span class="signature">(userId)</span><span class="type-signature"> &rarr; {Promise.&lt;(any|string|null)>}</span></h4>
1255
-
1256
-
1257
-
1258
-
1259
-
1260
-
1261
- <dl class="details">
1262
-
1263
- <dt class="tag-description">Description:</dt>
1264
- <dd class="tag-description"><ul class="dummy"><li>Unblock the provided user. Returns a 422 if the user wasn't blocked</li></ul></dd>
1265
-
1266
-
1267
-
1268
- <dt class="tag-source">Source:</dt>
1269
- <dd class="tag-source"><ul class="dummy"><li>
1270
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line37">line 37</a>
1271
- </li></ul></dd>
1272
-
1273
-
1274
-
1275
-
1276
-
1277
-
1278
-
1279
-
1280
-
1281
-
1282
-
1283
-
1284
-
1285
-
1286
-
1287
-
1288
-
1289
-
1290
-
1291
-
1292
-
1293
-
1294
-
1295
-
1296
-
1297
-
1298
-
1299
-
1300
-
1301
-
1302
-
1303
- </dl>
1304
-
1305
-
1306
-
1307
-
1308
-
1309
-
1310
-
1311
-
1312
-
1313
-
1314
-
1315
-
1316
-
1317
- <h5 class="h5-parameters">Parameters:</h5>
1318
-
1319
-
1320
- <table class="params">
1321
- <thead>
1322
- <tr>
1323
-
1324
- <th>Name</th>
1325
-
1326
-
1327
- <th>Type</th>
1328
-
1329
-
1330
-
1331
-
1332
-
1333
- <th class="last">Description</th>
1334
- </tr>
1335
- </thead>
1336
-
1337
- <tbody>
1338
-
1339
-
1340
- <tr>
1341
-
1342
- <td class="name"><code>userId</code></td>
1343
-
1344
-
1345
- <td class="type">
1346
-
1347
- </td>
1348
-
1349
-
1350
-
1351
-
1352
-
1353
- <td class="description last"></td>
1354
- </tr>
1355
-
1356
-
1357
- </tbody>
1358
- </table>
1359
-
1360
-
1361
-
1362
-
1363
-
1364
-
1365
-
1366
-
1367
-
1368
-
1369
-
1370
-
1371
-
1372
-
1373
-
1374
-
1375
- <h5 class="h5-returns">Returns:</h5>
1376
-
1377
-
1378
-
1379
-
1380
- <dl class="param-type">
1381
- <dt>
1382
- Type
1383
- </dt>
1384
- <dd>
1385
-
1386
- <span class="param-type">Promise.&lt;(any|string|null)></span>
1387
-
1388
-
1389
-
1390
- </dd>
1391
- </dl>
1392
-
1393
-
1394
-
1395
-
1396
-
1397
-
1398
-
1399
-
1400
-
1401
-
1402
- <h4 class="name" id=".updateDisplayName"><span class="type-signature type-signature-static">(static) </span>updateDisplayName<span class="signature">(newDisplayName)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#User">User</a>>}</span></h4>
1403
-
1404
-
1405
-
1406
-
1407
-
1408
-
1409
- <dl class="details">
1410
-
1411
-
1412
-
1413
- <dt class="tag-source">Source:</dt>
1414
- <dd class="tag-source"><ul class="dummy"><li>
1415
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line144">line 144</a>
1416
- </li></ul></dd>
1417
-
1418
-
1419
-
1420
-
1421
-
1422
-
1423
-
1424
-
1425
-
1426
-
1427
-
1428
-
1429
-
1430
-
1431
-
1432
-
1433
-
1434
-
1435
-
1436
-
1437
-
1438
-
1439
-
1440
-
1441
-
1442
-
1443
-
1444
-
1445
-
1446
-
1447
-
1448
- </dl>
1449
-
1450
-
1451
-
1452
-
1453
-
1454
-
1455
-
1456
-
1457
-
1458
-
1459
-
1460
-
1461
-
1462
- <h5 class="h5-parameters">Parameters:</h5>
1463
-
1464
-
1465
- <table class="params">
1466
- <thead>
1467
- <tr>
1468
-
1469
- <th>Name</th>
1470
-
1471
-
1472
- <th>Type</th>
1473
-
1474
-
1475
-
1476
-
1477
-
1478
- <th class="last">Description</th>
1479
- </tr>
1480
- </thead>
1481
-
1482
- <tbody>
1483
-
1484
-
1485
- <tr>
1486
-
1487
- <td class="name"><code>newDisplayName</code></td>
1488
-
1489
-
1490
- <td class="type">
1491
-
1492
- </td>
1493
-
1494
-
1495
-
1496
-
1497
-
1498
- <td class="description last">The new display name to set for the user.</td>
1499
- </tr>
1500
-
1501
-
1502
- </tbody>
1503
- </table>
1504
-
1505
-
1506
-
1507
-
1508
-
1509
-
1510
-
1511
-
1512
-
1513
-
1514
-
1515
-
1516
-
1517
-
1518
-
1519
-
1520
- <h5 class="h5-returns">Returns:</h5>
1521
-
1522
-
1523
- <div class="param-desc">
1524
- - A promise that resolves when the display name is updated.
1525
- </div>
1526
-
1527
-
1528
-
1529
- <dl class="param-type">
1530
- <dt>
1531
- Type
1532
- </dt>
1533
- <dd>
1534
-
1535
- <span class="param-type">Promise.&lt;<a href="global.html#User">User</a>></span>
1536
-
1537
-
1538
-
1539
- </dd>
1540
- </dl>
1541
-
1542
-
1543
-
1544
-
1545
-
1546
-
1547
-
1548
-
1549
-
1550
-
1551
- <h4 class="name" id=".uploadPicture"><span class="type-signature type-signature-static">(static) </span>uploadPicture<span class="signature">(fieldKey, file)</span><span class="type-signature"> &rarr; {Promise.&lt;(any|string|null)>}</span></h4>
1552
-
1553
-
1554
-
1555
-
1556
-
1557
-
1558
- <dl class="details">
1559
-
1560
- <dt class="tag-description">Description:</dt>
1561
- <dd class="tag-description"><ul class="dummy"><li>Upload a picture to the server</li></ul></dd>
1562
-
1563
-
1564
-
1565
- <dt class="tag-source">Source:</dt>
1566
- <dd class="tag-source"><ul class="dummy"><li>
1567
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line48">line 48</a>
1568
- </li></ul></dd>
1569
-
1570
-
1571
-
1572
-
1573
-
1574
-
1575
-
1576
-
1577
-
1578
-
1579
-
1580
-
1581
-
1582
-
1583
-
1584
-
1585
-
1586
-
1587
-
1588
-
1589
-
1590
-
1591
-
1592
-
1593
-
1594
-
1595
-
1596
-
1597
-
1598
-
1599
-
1600
- </dl>
1601
-
1602
-
1603
-
1604
-
1605
-
1606
-
1607
-
1608
-
1609
-
1610
-
1611
-
1612
-
1613
-
1614
- <h5 class="h5-parameters">Parameters:</h5>
1615
-
1616
-
1617
- <table class="params">
1618
- <thead>
1619
- <tr>
1620
-
1621
- <th>Name</th>
1622
-
1623
-
1624
- <th>Type</th>
1625
-
1626
-
1627
-
1628
-
1629
-
1630
- <th class="last">Description</th>
1631
- </tr>
1632
- </thead>
1633
-
1634
- <tbody>
1635
-
1636
-
1637
- <tr>
1638
-
1639
- <td class="name"><code>fieldKey</code></td>
1640
-
1641
-
1642
- <td class="type">
1643
-
1644
-
1645
- <span class="param-type">string</span>
1646
-
1647
-
1648
-
1649
-
1650
- </td>
1651
-
1652
-
1653
-
1654
-
1655
-
1656
- <td class="description last"></td>
1657
- </tr>
1658
-
1659
-
1660
-
1661
- <tr>
1662
-
1663
- <td class="name"><code>file</code></td>
1664
-
1665
-
1666
- <td class="type">
1667
-
1668
-
1669
- <span class="param-type">File</span>
1670
-
1671
-
1672
-
1673
-
1674
- </td>
1675
-
1676
-
1677
-
1678
-
1679
-
1680
- <td class="description last"></td>
1681
- </tr>
1682
-
1683
-
1684
- </tbody>
1685
- </table>
1686
-
1687
-
1688
-
1689
-
1690
-
1691
-
1692
-
1693
-
1694
-
1695
-
1696
-
1697
-
1698
-
1699
-
1700
-
1701
-
1702
- <h5 class="h5-returns">Returns:</h5>
1703
-
1704
-
1705
-
1706
-
1707
- <dl class="param-type">
1708
- <dt>
1709
- Type
1710
- </dt>
1711
- <dd>
1712
-
1713
- <span class="param-type">Promise.&lt;(any|string|null)></span>
1714
-
1715
-
1716
-
1717
- </dd>
1718
- </dl>
1719
-
1720
-
1721
-
1722
-
1723
-
1724
-
1725
-
1726
-
1727
-
1728
-
1729
- <h4 class="name" id=".uploadPictureFromS3"><span class="type-signature type-signature-static">(static) </span>uploadPictureFromS3<span class="signature">(fieldKey, s3_bucket_path)</span><span class="type-signature"> &rarr; {Promise.&lt;(any|string|null)>}</span></h4>
1730
-
1731
-
1732
-
1733
-
1734
-
1735
-
1736
- <dl class="details">
1737
-
1738
- <dt class="tag-description">Description:</dt>
1739
- <dd class="tag-description"><ul class="dummy"><li>Saves a picture uploaded to S3</li></ul></dd>
1740
-
1741
-
1742
-
1743
- <dt class="tag-source">Source:</dt>
1744
- <dd class="tag-source"><ul class="dummy"><li>
1745
- <a href="user_management.js.html">user/management.js</a>, <a href="user_management.js.html#line82">line 82</a>
1746
- </li></ul></dd>
1747
-
1748
-
1749
-
1750
-
1751
-
1752
-
1753
-
1754
-
1755
-
1756
-
1757
-
1758
-
1759
-
1760
-
1761
-
1762
-
1763
-
1764
-
1765
-
1766
-
1767
-
1768
-
1769
-
1770
-
1771
-
1772
-
1773
-
1774
-
1775
-
1776
-
1777
-
1778
- </dl>
1779
-
1780
-
1781
-
1782
-
1783
-
1784
-
1785
-
1786
-
1787
-
1788
-
1789
-
1790
-
1791
-
1792
- <h5 class="h5-parameters">Parameters:</h5>
1793
-
1794
-
1795
- <table class="params">
1796
- <thead>
1797
- <tr>
1798
-
1799
- <th>Name</th>
1800
-
1801
-
1802
- <th>Type</th>
1803
-
1804
-
1805
-
1806
-
1807
-
1808
- <th class="last">Description</th>
1809
- </tr>
1810
- </thead>
1811
-
1812
- <tbody>
1813
-
1814
-
1815
- <tr>
1816
-
1817
- <td class="name"><code>fieldKey</code></td>
1818
-
1819
-
1820
- <td class="type">
1821
-
1822
-
1823
- <span class="param-type">string</span>
1824
-
1825
-
1826
-
1827
-
1828
- </td>
1829
-
1830
-
1831
-
1832
-
1833
-
1834
- <td class="description last"></td>
1835
- </tr>
1836
-
1837
-
1838
-
1839
- <tr>
1840
-
1841
- <td class="name"><code>s3_bucket_path</code></td>
1842
-
1843
-
1844
- <td class="type">
1845
-
1846
-
1847
- <span class="param-type">string</span>
1848
-
1849
-
1850
-
1851
-
1852
- </td>
1853
-
1854
-
1855
-
1856
-
1857
-
1858
- <td class="description last"></td>
1859
- </tr>
1860
-
1861
-
1862
- </tbody>
1863
- </table>
1864
-
1865
-
1866
-
1867
-
1868
-
1869
-
1870
-
1871
-
1872
-
1873
-
1874
-
1875
-
1876
-
1877
-
1878
-
1879
-
1880
- <h5 class="h5-returns">Returns:</h5>
1881
-
1882
-
1883
-
1884
-
1885
- <dl class="param-type">
1886
- <dt>
1887
- Type
1888
- </dt>
1889
- <dd>
1890
-
1891
- <span class="param-type">Promise.&lt;(any|string|null)></span>
1892
-
1893
-
1894
-
1895
- </dd>
1896
- </dl>
1897
-
1898
-
1899
-
1900
-
1901
-
1902
-
1903
-
1904
-
1905
-
1906
-
1907
-
1908
- </article>
1909
-
1910
- </section>
1911
-
1912
-
1913
-
1914
-
1915
-
1916
-
1917
- </div>
1918
-
1919
- <br class="clear">
1920
-
1921
- <footer>
1922
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Nov 28 2025 11:22:56 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1923
- </footer>
1924
-
1925
- <script>prettyPrint();</script>
1926
- <script src="scripts/polyfill.js"></script>
1927
- <script src="scripts/linenumber.js"></script>
1928
-
1929
-
1930
-
1931
- </body>
1932
- </html>