Class NotificationService

Hierarchy

ComponentGroup
- NotificationService
  - Email
  - Firebase
  - Slack
  - Text
  - Notification

Implements

Component

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NotificationService(options: NotificationServiceOptions): NotificationService

Overrides ComponentGroup.__constructor
- Defined in base/NotificationService.ts:7
Instantiates a new Notification service.

Parameters
- options: NotificationServiceOptions
  
  The notification service options
Returns NotificationService

Properties

children

children: Component[]

logger

logger: LoggerInstance

options

options: NotificationServiceOptions

The notification service options

type

type: GROUP

Methods

component

component(component: Component): number

Inherited from ComponentGroup.component
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:50
Register a new component.

Parameters
- component: Component
Returns number

components

components(): Component[]

Inherited from ComponentGroup.components
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:46
Gets currently registered components.

Returns Component[]

describe

describe(): ComponentGroupDescription

Inherited from ComponentGroup.describe
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:26
Describes current component group.

Returns ComponentGroupDescription

onInit

onInit(server: BaseServer): Promise<void>

Inherited from ComponentGroup.onInit
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:34
Handles pre initialization routines.

Parameters
- server: BaseServer
Returns Promise<void>

onMount

onMount(server: BaseServer): void

Inherited from ComponentGroup.onMount
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:30
Handles post mount routines.

Parameters
- server: BaseServer
Returns void

onReady

onReady(server: BaseServer): Promise<void>

Inherited from ComponentGroup.onReady
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:38
Handles post initialization routines.

Parameters
- server: BaseServer
Returns Promise<void>

onUnmount

onUnmount(server: BaseServer): void

Inherited from ComponentGroup.onUnmount
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework-notification/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:42
Handles post unmount routines.

Parameters
- server: BaseServer
Returns void

Abstract send

send(message: BaseMessageSchema, options?: any): any

- Defined in base/NotificationService.ts:23
Sends a new message through the notification service.

Parameters
- message: BaseMessageSchema
- Optional options: any
  
  The options to be used in the transport
Returns any

Generated using TypeDoc