Class UserEntity

Description

Entity for a user in the nodeblocks platform. Users are the primary entity in the platform, and have different roles (access levels)

Hierarchy

  • BaseMongoEntity
    • UserEntity

Implements

  • WithCustomFields
  • User

Constructors

constructor

Properties

addressLine1 addressLine2 addressLine3 avatar? customFields deactivatedAt? email? emailVerified failedAttempts isLocked name password? phoneNumber postalCode preferences? provider? providerId? reviewStats? timeline? typeId

Constructors

constructor

Properties

addressLine1

addressLine1: string

Address line 1

addressLine2

addressLine2: string

Address line 2

addressLine3

addressLine3: string

Address line 3

Optional avatar

avatar?: string

Avatar object id in bucket

customFields

customFields: Record<string, unknown>

Custom fields for the user

Optional deactivatedAt

deactivatedAt?: null | Date

deactivatedAt

Optional email

email?: string

The user's email (blank when not used)

emailVerified

emailVerified: boolean

Whether the user's email has been verified

failedAttempts

failedAttempts: number

Number of failed login attempts

isLocked

isLocked: boolean

Whether the user is locked (locked users cannot be logged in to)

name

name: string

The user's display name

Optional password

password?: string

The user's password (when NOT using oauth login)

phoneNumber

phoneNumber: string

The phone number for the user

postalCode

postalCode: string

The postal code of the user

Optional preferences

preferences?: {
    key: string;
    value: string;
}[]

User preferences (this is unrelated to the user preferences table; use when a separate table is not needed)

Type declaration

  • key: string
  • value: string

Optional provider

provider?: string

Which provider the user has an oauth login with (google, twitter etc)

Optional providerId

providerId?: string

The id of the user in the oauth provider

Optional reviewStats

reviewStats?: {
    averageRate?: number;
    averageSubRates?: Record<string, number>;
    totalCount?: number;
}

Statistics for reviews made against this user

Type declaration

  • Optional averageRate?: number
  • Optional averageSubRates?: Record<string, number>
  • Optional totalCount?: number

Optional timeline

timeline?: UserTimelines

Timeline array object

typeId

typeId: "100" | "010" | "011" | "001" | "000"

Type (role) of the user

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc