// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

import {Relation} from '@nozbe/watermelondb';
import Model, {Associations} from '@nozbe/watermelondb/Model';

import User from '@typings/database/user';

/**
 * The Preference model hold information about the user's preference in the app.
 * This includes settings about the account, the themes, etc.
 */
export default class Preference extends Model {
    /** table (entity name) : Preference */
    static table: string;

    /** associations : Describes every relationship to this entity. */
    static associations: Associations;

    /** category : The preference category ( e.g. Themes, Account settings etc..) */
    category: string;

    /** name : The category name */
    name: string;

    /** user_id : The foreign key of the user's record in this model */
    userId: string;

    /** value : The preference's value */
    value: string;

    /** user : The related record to the parent User model */
    user: Relation<User>;
}