@chelseaapps/notification documentation

File

Description

Notification object to send to user(s)

Index

Properties

body
body: string
Type : string
Optional
Default notification content. Overriden by emailBody and pushBody.

emailBody
emailBody: string
Type : string
Optional
Provide specific email content. Overrides body.

from
from: string
Type : string
Optional
Email sender (default used if not given)

pushBody
pushBody: string
Type : string
Optional
Provide specific push content. Overrides body.

smsBody
smsBody: string
Type : string
Optional
Provide specific SMS content. Overrides body.

to
to: INotificationUser | INotificationUser[]
Type : INotificationUser | INotificationUser[]
User or list of users to send to

import { INotificationUser } from './user.interface';

/**
 * Available notification delivery methods
 */
export enum NotificationMethod {
    /**
     * Send to user's email
     */
    Email,
    /**
     * Send to user's device
     */
    Push,
    /**
     * Send text to user's mobile
     */
    SMS,
}

/**
 * Notification object to send to user(s)
 */
export interface INotification {
    /**
     * Delivery method(s) to use to send notification
     */
    methods: NotificationMethod[];

    /**
     * User or list of users to send to
     */
    to: INotificationUser | INotificationUser[];

    /**
     * Email sender (default used if not given)
     */
    from?: string;

    /**
     * Header item
     * @description Optional if SMS
     */
    subject?: string;

    /**
     * Default notification content. Overriden by `emailBody` and `pushBody`.
     */
    body?: string;

    /**
     * Provide specific email content. Overrides `body`.
     */
    emailBody?: string;

    /**
     * Provide specific push content. Overrides `body`.
     */
    pushBody?: string;

    /**
     * Provide specific SMS content. Overrides `body`.
     */
    smsBody?: string;
}