Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EmailChangeService

Email changing services.

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly dbm

dbm: default

Methods

changeEmail

  • changeEmail(emailChangeID: string): Promise<boolean>

  • Change a user's email address.

    Parameters

    • emailChangeID: string

      An email change record's ID.

    Returns Promise<boolean>

    Whether or not the email change was successful.

createEmailChangeRecord

  • createEmailChangeRecord(userID: string, newEmail: string, prune?: boolean): Promise<string>

  • Create an email change record.

    Parameters

    • userID: string

      The user's ID.

    • newEmail: string

      The new email address.

    • prune: boolean = true

      Whether or not to prune the record when the time comes.

    Returns Promise<string>

    The new email change record's ID.

deleteEmailChangeRecord

  • deleteEmailChangeRecord(emailChangeID: string): Promise<void>

  • Delete an email change record.

    Parameters

    • emailChangeID: string

      An email change record's ID.

    Returns Promise<void>

deleteEmailChangeRecordByUserID

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

  • Delete an email change record for a given user.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<void>

editEmailChangeRecord

  • editEmailChangeRecord(userID: string, newEmail: string): Promise<string>

  • Edit an email change record.

    Parameters

    • userID: string

      A user's ID.

    • newEmail: string

      The new email address.

    Returns Promise<string>

    The existing email change record's ID.

emailChangeRecordExists

  • emailChangeRecordExists(emailChangeID: string): Promise<boolean>

  • Check if an email change record exists.

    Parameters

    • emailChangeID: string

      An email change record's ID.

    Returns Promise<boolean>

    Whether or not the email change record exists.

emailChangeRecordExistsByUserID

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

  • Check if an email change record exists for a given user.

    Parameters

    • userID: string

      A user's ID.

    Returns Promise<boolean>

    Whether or not the email change record exists.

getEmailChangeRecord

  • getEmailChangeRecord(emailChangeID: string): Promise<EmailChange>

  • Get an email change record.

    Parameters

    • emailChangeID: string

      An email change record's ID.

    Returns Promise<EmailChange>

    The email change record.

getEmailChangeRecordByUserID

  • getEmailChangeRecordByUserID(userID: string): Promise<EmailChange>

  • Get an email change record for a given user.

    Parameters

    • userID: string

    Returns Promise<EmailChange>

    The email change record.

Generated using TypeDoc