Class ReferralController

Referral controller.

Hierarchy

ReferralController

Index

Constructors

constructor

Methods

Constructors

constructor

new ReferralController(referralService: ReferralService): ReferralController

- Defined in src/controllers/referral/referral.controller.ts:28
Parameters
- referralService: ReferralService
Returns ReferralController

Methods

getReferral

getReferral(user: NBUser): Promise<NBReferral>

- Defined in src/controllers/referral/referral.controller.ts:54
Get the user's referral record.

Parameters
- user: NBUser
  
  The user.
Returns Promise<NBReferral>

The user referral.

getReferrals

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

- Defined in src/controllers/referral/referral.controller.ts:68
Get all referrals associated with a user.

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

All referral records associated with the user.

reachedReferralThreshold

reachedReferralThreshold(user: NBUser): Promise<boolean>

- Defined in src/controllers/referral/referral.controller.ts:87
Get whether or not the user has reached the referral threshold.

Parameters
- user: NBUser
  
  The user.
Returns Promise<boolean>

Whether or not the user has reached the referral threshold.

referUser

referUser(userID: string, user: NBUser): Promise<NBReferral>

- Defined in src/controllers/referral/referral.controller.ts:39
Refer a user.

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

The new referral.

Generated using TypeDoc