Class BaseNotificationsServiceAbstract

constructor

• new BaseNotificationsService(
      notificationRegistry: NotificationRegistry,
  ): BaseNotificationsService

  Parameters

  • notificationRegistry: NotificationRegistry

  Returns BaseNotificationsService

logger

repository

• get repository(): Repository<Notification>

  Returns Repository<Notification>

create

• create<N extends Notification>(
      notificationyClassRef: Type<N>,
      opts: CreateNotificationOptions,
      ctx: BaseServiceMethodContext,
  ): Promise<N>

  Create a new notification.

  Type Parameters

  • N extends Notification

  Parameters

  • notificationyClassRef: Type<N>

    The notification class ref (e.g. TestNotification).
  • opts: CreateNotificationOptions

    The options for creating the notification.
  • ctx: BaseServiceMethodContext

    The context for the service method.

  Returns Promise<N>

  The created notification.

  Throws

  InternalServerErrorException if the notification creation fails.

getMany

• getMany(
      options: GetManyNotificationsOptions,
  ): Promise<[Notification[], ListMeta]>

  Retrieves multiple notification entities based on the provided options.

  Parameters

  • options: GetManyNotificationsOptions

    The options to use when retrieving the notification entities.

  Returns Promise<[Notification[], ListMeta]>

  A promise that resolves to an array containing the retrieved notification entities and list metadata.

getNotificationClassRefOrFail

• getNotificationClassRefOrFail(
      notificationType: string,
      ctx: BaseServiceMethodContext,
  ): Type<Notification>

  Retrieves the class reference for a notification entity of the specified type or throws a NotFoundException if it is not found.

  Parameters

  • notificationType: string

    The type of the notification entity to retrieve.
  • ctx: BaseServiceMethodContext

    The context of the service method.

  Returns Type<Notification>

  The class reference for the specified notification entity type.

  Throws

  If the notification entity is not found.

getOne

• getOne<N extends Notification>(
      classRef: Type<N>,
      id: string,
  ): Promise<MaybeNull<N>>

  Retrieves a single notification entity of the specified class by the given ID.

  Type Parameters

  • N extends Notification

    The type of the notification entity to retrieve.

  Parameters

  • classRef: Type<N>

    The class reference of the notification entity to retrieve.
  • id: string

    The ID of the notification entity to retrieve.

  Returns Promise<MaybeNull<N>>

  A promise that resolves to the retrieved notification entity, or null if it was not found.

getOneBy

• getOneBy<N extends Notification>(
      classRef: Type<N>,
      __namedParameters: GetNotificationByOptions,
      ctx: BaseServiceMethodContext,
  ): Promise<MaybeNull<N>>

  Retrieves a single notification entity of the specified class by the given options.

  Type Parameters

  • N extends Notification

    The type of the notification entity to retrieve.

  Parameters

  • classRef: Type<N>

    The class reference of the notification entity to retrieve.
  • __namedParameters: GetNotificationByOptions
  • ctx: BaseServiceMethodContext

  Returns Promise<MaybeNull<N>>

  A promise that resolves to the retrieved notification entity, or null if it was not found.

getOneByOrFail

• getOneByOrFail<N extends Notification>(
      classRef: Type<N>,
      opts: GetNotificationByOptions,
      ctx: BaseServiceMethodContext,
  ): Promise<N>

  Retrieves a single notification entity of the specified class by the given options or throws a NotFoundException if it is not found.

  Type Parameters

  • N extends Notification

    The type of the notification entity to retrieve.

  Parameters

  • classRef: Type<N>

    The class reference of the notification entity to retrieve.
  • opts: GetNotificationByOptions

    The options to use when retrieving the notification entity.
  • ctx: BaseServiceMethodContext

    The context of the service method.

  Returns Promise<N>

  A promise that resolves to the retrieved notification entity.

  Throws

  If the options object is empty.

  Throws

  If the notification entity is not found.

getOneOrFail

• getOneOrFail<N extends Notification>(
      classRef: Type<N>,
      id: string,
      ctx: BaseServiceMethodContext,
  ): Promise<N>

  Retrieves a single notification entity of the specified class by the given ID or throws a NotFoundException if it is not found.

  Type Parameters

  • N extends Notification

    The type of the notification entity to retrieve.

  Parameters

  • classRef: Type<N>

    The class reference of the notification entity to retrieve.
  • id: string

    The ID of the notification entity to retrieve.
  • ctx: BaseServiceMethodContext

    The context of the service method.

  Returns Promise<N>

  A promise that resolves to the retrieved notification entity.

  Throws

  If the options object is empty.

  Throws

  If the notification entity is not found.

getSenders

• getSenders(
      notification: Notification,
  ): NotificationSender<Notification, unknown>[]

  Parameters

  • notification: Notification

  Returns NotificationSender<Notification, unknown>[]

getUnreadNotificationCount

• getUnreadNotificationCount(ctx: BaseServiceMethodContext): Promise<number>

  Get unread notifications count.

  Parameters

  • ctx: BaseServiceMethodContext

    The context for the service method.

  Returns Promise<number>

markNotificationsAsRead

• markNotificationsAsRead(
      ids: string[],
      ctx: BaseServiceMethodContext,
  ): Promise<void>

  Mark notifications as read.

  Parameters

  • ids: string[]

    List of notification IDs to mark as read.
  • ctx: BaseServiceMethodContext

    The context for the service method.

  Returns Promise<void>

  Throws

  InternalServerErrorException if the notifications update fails.

onModuleInit

• onModuleInit(): void

  Returns void

sendNotification

• sendNotification(
      id: string,
      ctx: BaseServiceMethodContext,
  ): Promise<Notification>

  Parameters

  • id: string
  • ctx: BaseServiceMethodContext

  Returns Promise<Notification>

update

• update(
      opts: UpdateNotificationOptions,
      ctx: BaseServiceMethodContext,
  ): Promise<Notification>

  Update a notification.

  Parameters

  • opts: UpdateNotificationOptions

    The options for updating the notification.
  • ctx: BaseServiceMethodContext

    The context for the service method.

  Returns Promise<Notification>

  The updated notification.

  Throws

  InternalServerErrorException if the notification update fails.