Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Notification

Hierarchy

Implements

  • Component

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

children

children: Component[]

logger

logger: LoggerInstance

options

options: NotificationServiceOptions

The notification service options

type

type: GROUP

Static EmailMessage

EmailMessage: EmailMessage = EmailMessage

Static FirebaseMessage

FirebaseMessage: FirebaseMessage = FirebaseMessage

Static SlackMessage

SlackMessage: SlackMessage = SlackMessage

Static TextMessage

TextMessage: TextMessage = TextMessage

Methods

component

  • component(component: Component): number

  • Register a new component.

    Parameters

    • component: Component

    Returns number

components

  • components(): Component[]

  • Gets currently registered components.

    Returns Component[]

describe

  • describe(): ComponentGroupDescription

  • Describes current component group.

    Returns ComponentGroupDescription

Protected getByType

  • getByType<T>(type: object): T | undefined

onInit

  • onInit(server: BaseServer): Promise<void>

  • Handles pre initialization routines.

    Parameters

    • server: BaseServer

    Returns Promise<void>

onMount

  • onMount(server: BaseServer): void

  • Handles post mount routines.

    Parameters

    • server: BaseServer

    Returns void

onReady

  • onReady(server: BaseServer): Promise<void>

  • Handles post initialization routines.

    Parameters

    • server: BaseServer

    Returns Promise<void>

onUnmount

  • onUnmount(server: BaseServer): void

  • Handles post unmount routines.

    Parameters

    • server: BaseServer

    Returns void

send

  • send(message: Message, options?: any): Promise<any>

  • Send a notification using the currently available and configured transporters.

    Parameters

    • message: Message

      The notification to be sent, can be an Email message, a Firebase message or a Text message.

    • Optional options: any

      The options to be sent to the Transporter

    Returns Promise<any>

Generated using TypeDoc