EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 EspoCRM, Inc.
* Website: https://www.espocrm.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
/** @module models/preferences */
import Model from 'model';
/**
* User preferences.
*/
class Preferences extends Model {
name = 'Preferences'
entityType = 'Preferences'
urlRoot = 'Preferences'
/**
* @private
* @type {import('models/settings').default}
*/
settings
/**
* Get dashlet options.
*
* @param {string} id A dashlet ID.
* @returns {Object|null}
*/
getDashletOptions(id) {
const value = this.get('dashletsOptions') || {};
return value[id] || null;
}
/**
* Whether a user is portal.
*
* @returns {boolean}
*/
isPortal() {
return this.get('isPortalUser');
}
/**
* @internal
* @param {import('models/settings').default} settings
*/
setSettings(settings) {
this.settings = settings;
}
}
export default Preferences;