API Reference
Rockets Core API
nestjs-invitation
classes
InvitationService

Class: InvitationService

Implements

  • InvitationServiceInterface

Constructors

new InvitationService()

new InvitationService(invitationSendService, invitationAcceptanceService, invitationRevocationService): InvitationService

Parameters

ParameterType
invitationSendServiceInvitationSendService
invitationAcceptanceServiceInvitationAcceptanceService
invitationRevocationServiceInvitationRevocationService

Returns

InvitationService

Defined in

packages/nestjs-invitation/src/services/invitation.service.ts:17 (opens in a new tab)

Methods

accept()

accept(invitationDto, passcode, payload?, queryOptions?): Promise<boolean>

Activate user's account by providing its OTP passcode and the new password.

Parameters

ParameterType
invitationDtoInvitationDto
passcodestring
payload?LiteralObject<unknown>
queryOptions?QueryOptionsInterface

Returns

Promise<boolean>

Implementation of

InvitationServiceInterface.accept

Defined in

packages/nestjs-invitation/src/services/invitation.service.ts:35 (opens in a new tab)

revokeAll()

revokeAll(email, category, queryOptions?): Promise<void>

Revoke all invitations by email and category.

Parameters

ParameterTypeDescription
emailstringuser email
categorystringthe category
queryOptions?QueryOptionsInterface-

Returns

Promise<void>

Implementation of

InvitationServiceInterface.revokeAll

Defined in

packages/nestjs-invitation/src/services/invitation.service.ts:55 (opens in a new tab)

send()

send(user, code, category, queryOptions?): Promise<void>

Parameters

ParameterType
userReferenceIdInterface<string> & ReferenceEmailInterface<string>
codestring
categorystring
queryOptions?QueryOptionsInterface

Returns

Promise<void>

Implementation of

InvitationServiceInterface.send

Defined in

packages/nestjs-invitation/src/services/invitation.service.ts:23 (opens in a new tab)

InvitationPostgresEntityInvitationSqliteEntity