Home Reference Source

src/users-new/User.ts

import {PresenceActivity} from './PresenceActivity';
import {PresenceMood} from './PresenceMood';
import {UserRole} from './UserRole';

/**
 * Represents a user. Look at {@link UserRepository} documentation to find the available ways
 * to obtain objects adhering to this interface
 */
export type User = Readonly<{
	id: string;
	domain: string;
	username: string;
	email: string;
	mobilePhones: readonly string[];
	alias: string;
	role: UserRole;
	gatewayUsername?: string;
	online: boolean;
	activity: PresenceActivity;
	mood: PresenceMood;
	note: string;
	avatar: string;
	displayName: string;
}>;