Class PasswordResetService

Password reset table service.

Hierarchy

PasswordResetService

Index

Constructors

constructor

Methods

Constructors

constructor

new PasswordResetService(dbService: DBService, resourceService: ResourceService, userService: UserService): PasswordResetService

- Defined in src/services/password-reset/password-reset.service.ts:24
Parameters
- dbService: DBService
- resourceService: ResourceService
- userService: UserService
Returns PasswordResetService

Methods

createPasswordReset

createPasswordReset(userID: string): Promise<NBPasswordReset>

- Defined in src/services/password-reset/password-reset.service.ts:39
Create a password reset record.

Parameters
- userID: string
  
  The ID of the user requesting the password reset.
Returns Promise<NBPasswordReset>

The new password reset record.

deletePasswordReset

deletePasswordReset(passwordResetID: string): Promise<void>

- Defined in src/services/password-reset/password-reset.service.ts:172
Delete a password reset record.

Parameters
- passwordResetID: string
  
  The password reset record's ID.
Returns Promise<void>

getPasswordReset

getPasswordReset(passwordResetID: string): Promise<NBPasswordReset>

- Defined in src/services/password-reset/password-reset.service.ts:92
Get a password reset record.

Parameters
- passwordResetID: string
  
  The password reset record's ID.
Returns Promise<NBPasswordReset>

The password reset record.

getPasswordResetByUserID

getPasswordResetByUserID(userID: string): Promise<NBPasswordReset>

- Defined in src/services/password-reset/password-reset.service.ts:113
Get the password reset record associated with a user.

Parameters
- userID: string
  
  The ID of the user associated with the password reset record.
Returns Promise<NBPasswordReset>

The password reset record associated with the user.

getPasswordResets

getPasswordResets(): Promise<NBPasswordReset[]>

- Defined in src/services/password-reset/password-reset.service.ts:135
Get all password reset records.

Returns Promise<NBPasswordReset[]>

All password reset records.

getUserByPasswordReset

getUserByPasswordReset(passwordResetID: string): Promise<NBUser>

- Defined in src/services/password-reset/password-reset.service.ts:148
Get the user associated with a password reset record.

Parameters
- passwordResetID: string
  
  The password reset record's ID.
Returns Promise<NBUser>

The user associated with the password reset record.

passwordResetExists

passwordResetExists(passwordResetID: string): Promise<boolean>

- Defined in src/services/password-reset/password-reset.service.ts:64
Determine whether or not a password reset record exists.

Parameters
- passwordResetID: string
  
  The password reset ID.
Returns Promise<boolean>

Whether or not the password reset record exists.

passwordResetExistsByUserID

passwordResetExistsByUserID(userID: string): Promise<boolean>

- Defined in src/services/password-reset/password-reset.service.ts:78
Determine whether or not a password reset record exists for a given user ID.

Parameters
- userID: string
  
  The ID of the user associated with the password reset record.
Returns Promise<boolean>

Whether or not the password reset record exists for the given user ID.

prunePasswordResets

prunePasswordResets(): Promise<void>

- Defined in src/services/password-reset/password-reset.service.ts:220
Prune all old password reset records.

Returns Promise<void>

resetPassword

resetPassword(passwordResetID: string, newPassword: string): Promise<void>

- Defined in src/services/password-reset/password-reset.service.ts:182
Reset a user's password and delete the password reset record.

Parameters
- passwordResetID: string
  
  The password reset record's ID.
- newPassword: string
  
  The user's new password.
Returns Promise<void>

Generated using TypeDoc