Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Driver

Common abstract class for all drivers

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

  • new Driver(options: CommonDriverOptions): Driver

Properties

Readonly body

body: string

Private id

id: undefined | number

Id of the message in the database

Private Readonly name

name: string

Private Readonly type

type: Type

Methods

change

  • change(status: Status): Promise<void>

  • Change the message status. Also creates user or message if they don't exist

    Parameters

    Returns Promise<void>

run

  • run(): Promise<number>

  • Start delivering the message Method creates new message in the DB with the status CREATED and handles all errors

    Returns Promise<number>

Abstract start

  • start(): Promise<void>

  • Common method for all heirs to implement Starts the delivery of the message

    Returns Promise<void>

Static getHistory

  • getHistory(message: string | number): Promise<any>

Static getMessage

  • getMessage(id: string | number): Promise<any>

  • Get the message information with all status changes This method explicitly gets the history of the statuses for the speed-up

    Parameters

    • id: string | number

    Returns Promise<any>

Static getMessages

  • getMessages(): Promise<any>

Static getMessagesByUser

  • getMessagesByUser(name: string): Promise<any>

Static getUser

  • getUser(name: string): Promise<any>

Static getUsers

  • getUsers(): Promise<any>

Generated using TypeDoc