Files
mattermost-mobile/app/database/models/server/channel_membership.ts
Elias Nahum 81357d8a0e [Gekidou] Update database to hold if a user is a team or channel admin (#6351)
* Update database to hold if a user is a team or channel admin

* TeamMembership identifier

* Fix handleTeamMembership test

* Update server.md

Co-authored-by: Avinash Lingaloo <avinashlng1080@gmail.com>
2022-06-06 05:54:02 -04:00

59 lines
2.4 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import {Q, Relation} from '@nozbe/watermelondb';
import {field, immutableRelation, lazy} from '@nozbe/watermelondb/decorators';
import Model, {Associations} from '@nozbe/watermelondb/Model';
import {MM_TABLES} from '@constants/database';
import type ChannelModel from '@typings/database/models/servers/channel';
import type ChannelMembershipModelInterface from '@typings/database/models/servers/channel_membership';
import type UserModel from '@typings/database/models/servers/user';
const {CHANNEL, CHANNEL_MEMBERSHIP, USER} = MM_TABLES.SERVER;
/**
* The ChannelMembership model represents the 'association table' where many channels have users and many users are on
* channels ( N:N relationship between model Users and model Channel)
*/
export default class ChannelMembershipModel extends Model implements ChannelMembershipModelInterface {
/** table (name) : ChannelMembership */
static table = CHANNEL_MEMBERSHIP;
/** associations : Describes every relationship to this table. */
static associations: Associations = {
/** A CHANNEL can have multiple USER */
[CHANNEL]: {type: 'belongs_to', key: 'channel_id'},
/** A USER can belong to multiple CHANNEL */
[USER]: {type: 'belongs_to', key: 'user_id'},
};
/** channel_id : The foreign key to the related Channel record */
@field('channel_id') channelId!: string;
/* user_id: The foreign key to the related User record*/
@field('user_id') userId!: string;
/* scheme_admin: Determines if the user is an admin of the channel*/
@field('scheme_admin') schemeAdmin!: boolean;
/** memberChannel : The related channel this member belongs to */
@immutableRelation(CHANNEL, 'channel_id') memberChannel!: Relation<ChannelModel>;
/** memberUser : The related member belonging to the channel */
@immutableRelation(USER, 'user_id') memberUser!: Relation<UserModel>;
/**
* getAllChannelsForUser - Retrieves all the channels that the user is part of
*/
@lazy getAllChannelsForUser = this.collections.get<ChannelModel>(CHANNEL).query(Q.on(USER, 'id', this.userId));
/**
* getAllUsersInChannel - Retrieves all the users who are part of this channel
*/
@lazy getAllUsersInChannel = this.collections.get<UserModel>(USER).query(Q.on(CHANNEL, 'id', this.channelId));
}