Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserService

User services.

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly dbm

dbm: default

Methods

createUser

  • createUser(firstname: string, lastname: string, email: string, password: string, statusID: number): Promise<string>

  • Create a user.

    Parameters

    • firstname: string

      The user's first name.

    • lastname: string

      The user's last name.

    • email: string

      The user's email address.

    • password: string

      The user's password.

    • statusID: number

      The status ID of the user.

    Returns Promise<string>

    The new user's ID.

deleteUser

  • deleteUser(userID: string): Promise<void>

  • Delete a user.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<void>

deleteUserImage

  • deleteUserImage(userID: string): Promise<void>

  • Delete a user's image.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<void>

getUnapproved

  • Get all unapproved users.

    Returns Promise<UnapprovedUsers[]>

    All unapproved users.

getUser

  • getUser(userID: string): Promise<User>

  • Get a user.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<User>

    The user.

getUserByEmail

  • getUserByEmail(email: string): Promise<User>

  • Get a user by their email address.

    Parameters

    • email: string

      An email address.

    Returns Promise<User>

    The user.

getUserImage

  • getUserImage(userID: string): Promise<Image>

  • Get a user's image.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<Image>

    The user's profile image.

getUserStatusName

  • getUserStatusName(userID: string): Promise<string>

  • Get the name of a user's status.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<string>

    The name of the user's status.

isAdmin

  • isAdmin(userID: string): Promise<boolean>

  • Check if a user is an admin.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<boolean>

    Whether or not the user is an admin.

isApproved

  • isApproved(userID: string): Promise<boolean>

  • Check if a user's account has been approved.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<boolean>

    Whether or not the user's account has been approved.

isVerified

  • isVerified(userID: string): Promise<boolean>

  • Check if a user is verified.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<boolean>

    Whether or not the user's account has been verified.

login

  • login(email: string, password: string): Promise<LoginStatus>

  • Log a user in.

    Parameters

    • email: string

      The user's email address.

    • password: string

      The user's password.

    Returns Promise<LoginStatus>

    A login status code.

setAdmin

  • setAdmin(userID: string, admin?: boolean): Promise<void>

  • Set a user's admin status.

    Parameters

    • userID: string

      A user's ID.

    • admin: boolean = true

      Admin status.

    Returns Promise<void>

setApproved

  • setApproved(userID: string, approved?: boolean): Promise<void>

  • Set a user's approved status.

    Parameters

    • userID: string

      A user's ID.

    • approved: boolean = true

      Approved status.

    Returns Promise<void>

setUserImage

  • setUserImage(userID: string, imageData: Buffer): Promise<void>

  • Set a user's image.

    Parameters

    • userID: string

      A user's ID.

    • imageData: Buffer

      The new binary image data.

    Returns Promise<void>

setUserPassword

  • setUserPassword(userID: string, password: string): Promise<void>

  • Set a user's password.

    Parameters

    • userID: string

      A user's ID.

    • password: string

      The user's new password.

    Returns Promise<void>

setVerified

  • setVerified(userID: string, verified?: boolean): Promise<void>

  • Set a user's verification status.

    Parameters

    • userID: string

      A user's ID.

    • verified: boolean = true

      Verification status.

    Returns Promise<void>

uniqueEmail

  • uniqueEmail(email: string): Promise<boolean>

  • Make sure an email address is not yet in use.

    Parameters

    • email: string

      An email address.

    Returns Promise<boolean>

    Whether or not the email address is unique.

updateLastPostTime

  • updateLastPostTime(userID: string): Promise<void>

  • Update a user's last post timestamp.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<void>

userExists

  • userExists(userID: string): Promise<boolean>

  • Check if a user exists.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<boolean>

    Whether or not the user exists.

Generated using TypeDoc