[NEW] Add user settings / preferences API endpoint

packages/rocketchat-api/server/v1/users.js

@@ -271,6 +271,77 @@ RocketChat.API.v1.addRoute('users.createToken', { authRequired: true }, {
 	}
 });
 
+RocketChat.API.v1.addRoute('users.getPreferences', { authRequired: true }, {
+	get() {
+		const user = this.userId;
+		if (user.settings) {
+			const preferences = user.settings.preferences;
+			preferences['language'] = user.language;
+
+			return RocketChat.API.v1.success({
+				preferences
+			});
+		} else {
+			return RocketChat.API.v1.failure(TAPi18n.__('Accounts_Default_User_Preferences_not_available').toUpperCase());
+		}
+	}
+});
+
+RocketChat.API.v1.addRoute('users.setPreferences', { authRequired: true }, {
+	post() {
+		check(this.bodyParams, {
+			userId: Match.Maybe(String),
+			data: Match.ObjectIncluding({
+				newRoomNotification: Match.Maybe(String),
+				newMessageNotification: Match.Maybe(String),
+				useEmojis: Match.Maybe(Boolean),
+				convertAsciiEmoji: Match.Maybe(Boolean),
+				saveMobileBandwidth: Match.Maybe(Boolean),
+				collapseMediaByDefault: Match.Maybe(Boolean),
+				autoImageLoad: Match.Maybe(Boolean),
+				emailNotificationMode: Match.Maybe(String),
+				roomsListExhibitionMode: Match.Maybe(String),
+				unreadAlert: Match.Maybe(Boolean),
+				notificationsSoundVolume: Match.Maybe(Number),
+				desktopNotifications: Match.Maybe(String),
+				mobileNotifications: Match.Maybe(String),
+				enableAutoAway: Match.Maybe(Boolean),
+				highlights: Match.Maybe(Array),
+				desktopNotificationDuration: Match.Maybe(Number),
+				viewMode: Match.Maybe(Number),
+				hideUsernames: Match.Maybe(Boolean),
+				hideRoles: Match.Maybe(Boolean),
+				hideAvatars: Match.Maybe(Boolean),
+				hideFlexTab: Match.Maybe(Boolean),
+				sendOnEnter: Match.Maybe(String),
+				roomCounterSidebar: Match.Maybe(Boolean),
+				language: Match.Maybe(String),
+				sidebarShowFavorites: Match.Optional(Boolean),
+				sidebarShowUnread: Match.Optional(Boolean),
+				sidebarSortby: Match.Optional(String),
+				sidebarViewMode: Match.Optional(String),
+				sidebarHideAvatar: Match.Optional(Boolean),
+				mergeChannels: Match.Optional(Boolean),
+				muteFocusedConversations: Match.Optional(Boolean)
+			})
+		});
+
+		let preferences;
+		const userId = this.bodyParams.userId ? this.bodyParams.userId : this.userId;
+		if (this.bodyParams.data.language) {
+			const language = this.bodyParams.data.language;
+			delete this.bodyParams.data.language;
+			preferences = _.extend({ _id: userId, settings: { preferences: this.bodyParams.data }, language });
+		} else {
+			preferences = _.extend({ _id: userId, settings: { preferences: this.bodyParams.data }});
+		}
+
+		Meteor.runAsUser(this.userId, () => RocketChat.saveUser(this.userId, preferences));
+
+		return RocketChat.API.v1.success({ user: RocketChat.models.Users.findOneById(this.bodyParams.userId, { fields: preferences }) });
+	}
+});
+
 /**
 	This API returns the logged user roles.
 
@@ -290,4 +361,3 @@ RocketChat.API.v1.addRoute('user.roles', { authRequired: true }, {
 		return RocketChat.API.v1.success(currentUserRoles);
 	}
 });
-

packages/rocketchat-i18n/i18n/en.i18n.json

@@ -45,6 +45,7 @@
   "Accounts_Default_User_Preferences_audioNotifications": "Audio Notifications Default Alert",
   "Accounts_Default_User_Preferences_desktopNotifications": "Desktop Notifications Default Alert",
   "Accounts_Default_User_Preferences_mobileNotifications": "Mobile Notifications Default Alert",
+  "Accounts_Default_User_Preferences_not_available": "Failed to retrieve User Preferences because they haven't been set up by the user yet",
   "Accounts_denyUnverifiedEmail": "Deny unverified email",
   "Accounts_EmailVerification": "Email Verification",
   "Accounts_EmailVerification_Description": "Make sure you have correct SMTP settings to use this feature",

packages/rocketchat-lib/server/functions/saveUser.js

@@ -72,7 +72,8 @@ RocketChat.saveUser = function(userId, userData) {
 		const updateUser = {
 			$set: {
 				name: userData.name,
-				roles: userData.roles || ['user']
+				roles: userData.roles || ['user'],
+				settings: userData.settings
 			}
 		};
 
@@ -163,6 +164,15 @@ RocketChat.saveUser = function(userId, userData) {
 			updateUser.$set.roles = userData.roles;
 		}
 
+		if (userData.settings) {
+			updateUser.$set.settings = { preferences: {} };
+			for (const key in userData.settings.preferences) {
+				if (userData.settings.preferences[key]) {
+					updateUser.$set.settings.preferences[key] = userData.settings.preferences[key];
+				}
+			}
+		}
+
 		if (typeof userData.requirePasswordChange !== 'undefined') {
 			updateUser.$set.requirePasswordChange = userData.requirePasswordChange;
 		}