Class ReferralService

Referral table service.

Hierarchy

ReferralService

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in src/services/referral/referral.service.ts:23
Parameters
- dbService: DBService
- resourceService: ResourceService
- userService: UserService
Returns ReferralService

Methods

deleteReferral

deleteReferral(newUserID: string): Promise<void>

- Defined in src/services/referral/referral.service.ts:131
Delete a user's referral record.

Parameters
- newUserID: string
  
  The new user's ID.
Returns Promise<void>

deleteUserReferrals

deleteUserReferrals(userID: string): Promise<void>

- Defined in src/services/referral/referral.service.ts:142
Delete all referral records associated with a user.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<void>

getReferral

getReferral(newUserID: string): Promise<NBReferral>

- Defined in src/services/referral/referral.service.ts:72
Get the referral record for a user, or undefined if they did not refer someone.

Parameters
- newUserID: string
  
  The new user's ID.
Returns Promise<NBReferral>

The referral record.

getReferrals

getReferrals(userID: string): Promise<NBReferral[]>

- Defined in src/services/referral/referral.service.ts:90
Get all referral records associated with a user.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<NBReferral[]>

All referral records associated with the user.

reachedReferralThreshold

reachedReferralThreshold(userID: string): Promise<boolean>

- Defined in src/services/referral/referral.service.ts:110
Determine whether or not a user has reached the referral threshold.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<boolean>

Whether or not the user has reached the referral threshold.

referUser

referUser(userID: string, newUserID: string): Promise<NBReferral>

- Defined in src/services/referral/referral.service.ts:39
Refer a user.

Parameters
- userID: string
  
  The user's ID.
- newUserID: string
  
  The new user's ID.
Returns Promise<NBReferral>

The new referral record.

Generated using TypeDoc