Class AlertManager

Handles alert notifications and silence requests

Hierarchy

AlertManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AlertManager(baseDBPath?: string | BaseDBLevelUp, alertsDBPath?: string | AlertsDBLevelUp): AlertManager

- Defined in src/alertManager/AlertManager.ts:100
opens databases and initializes buttons

Parameters
- Optional baseDBPath: string | BaseDBLevelUp
  
  path or [[LevelUp]] object to use §as alertmanager database
- Optional alertsDBPath: string | AlertsDBLevelUp
  
  path or [[LevelUp]] object to use as alerts database
Returns AlertManager

instance

Properties

Private alerts

alerts: Level<AlertsDBValue>

Private db

db: LevelGraph<BaseDBKey>

Private Readonly silenceButtons

silenceButtons: InlineKeyboardButton[]

Methods

addAlert

addAlert(alert: IAlert): Promise<IAlert>

- Defined in src/alertManager/AlertManager.ts:322
Stores an alert

Parameters
- alert: IAlert
  
  the alert to store
Returns Promise<IAlert>

the alert itself

addAlertMessage

addAlertMessage(chatId: string, messageId: string, alertHash: string): Promise<void>

- Defined in src/alertManager/AlertManager.ts:215
Links a message and the alert on the state

Parameters
- chatId: string
  
  telegram chat ID
- messageId: string
  
  telegram message ID
- alertHash: string
  
  hash from IAlert.hash
Returns Promise<void>

resolves if added successfully

addUserChat

addUserChat(userId: string, chatId: string): Promise<void>

- Defined in src/alertManager/AlertManager.ts:199
Adds a user chat to the state

Parameters
- userId: string
  
  telegram user ID
- chatId: string
  
  telegram chat ID
Returns Promise<void>

void on success or throws error

delAlert

delAlert(alertHash: string): Promise<void>

- Defined in src/alertManager/AlertManager.ts:335
Deletes an alert

Parameters
- alertHash: string
  
  alert hash to delete
Returns Promise<void>

nothing

Private firingMessageMarkup

firingMessageMarkup(alert: IAlert): InlineKeyboardMarkup

- Defined in src/alertManager/AlertManager.ts:153
Inline keyboard markup for an alert

Parameters
- alert: IAlert
  
  alert to generate the markup for
Returns InlineKeyboardMarkup

keyboard markup

getAlert

getAlert(alertHash: string): Promise<IAlert>

- Defined in src/alertManager/AlertManager.ts:345
retrieves alert data from database by it's hash

Parameters
- alertHash: string
  
  alert hash from IAlert.hash
Returns Promise<IAlert>

alert data

getAlertFromMessage

getAlertFromMessage(messageId: string): Promise<IAlertMessage | undefined>

- Defined in src/alertManager/AlertManager.ts:295
Get the alert context for the given message

Parameters
- messageId: string
  
  telegram message ID
Returns Promise<IAlertMessage | undefined>

alert context

getChats

getChats(): Promise<ITriple<IAlertManagerPredicates>[]>

- Defined in src/alertManager/AlertManager.ts:312
Get all current chats on state

Returns Promise<ITriple<IAlertManagerPredicates>[]>

chat entries

getIdsFilteredBy

getIdsFilteredBy(filters: IAlertMessageFilters): Promise<IAlertMessage[]>

- Defined in src/alertManager/AlertManager.ts:236
get IAlertMessage list filtered by a given filter

Parameters
- filters: IAlertMessageFilters
  
  filter records per predicate
Returns Promise<IAlertMessage[]>

alert messages

getMessagesByAlert

getMessagesByAlert(alertHash: string): Promise<IAlertMessage[]>

- Defined in src/alertManager/AlertManager.ts:259
Gets all messages that have been sent for the given alert

Parameters
- alertHash: string
  
  alert hash from IAlert.hash
Returns Promise<IAlertMessage[]>

alert messages

getUnalertedChats

getUnalertedChats(alertHash: string): Promise<(string | number)[]>

- Defined in src/alertManager/AlertManager.ts:272
Gets all chats which haven't received the given alert

Parameters
- alertHash: string
  
  alert hash to search for
Returns Promise<(string | number)[]>

chats which didn't receive the alert

hasUserChat

hasUserChat(userId: string, chatId: string): Promise<boolean>

- Defined in src/alertManager/AlertManager.ts:180
Check whether a given user chat is already on state

Parameters
- userId: string
  
  telegram user ID
- chatId: string
  
  telegram chat ID
Returns Promise<boolean>

true if the chat exists on context state

processCallback

processCallback(ctx: IAlertManagerContext, next: () => Promise<void>): Promise<void>

- Defined in src/alertManager/AlertManager.ts:467
Parses a callback request if it is known

Parameters
- ctx: IAlertManagerContext
  
  bot context
- next: () => Promise<void>
  
  middleware callback
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>

callback chain result

processSilence

processSilence(ctx: IAlertManagerContext, time: string): Promise<void>

- Defined in src/alertManager/AlertManager.ts:507
silences alerts on alertmanager

Parameters
- ctx: IAlertManagerContext
  
  alertmanager context
- time: string
  
  silence period, e.g. 1h
Returns Promise<void>

callback chain result

sendAlertMessages

sendAlertMessages(alert: IAlert, telegram: Telegram): Promise<void>

- Defined in src/alertManager/AlertManager.ts:356
sends firing alert messages, or edits messages with resolved status

Parameters
- alert: IAlert
  
  alert data
- telegram: Telegram
  
  telegram object
Returns Promise<void>

callback chain result

Static silenceAlert

silenceAlert(alert: IAlert, time: string, username?: undefined | string, comment?: undefined | string): Promise<Response>

- Defined in src/alertManager/AlertManager.ts:427
Silence an alert

Parameters
- alert: IAlert
  
  the alert to silence
- time: string
  
  period to silence the alert, e.g. "1h"
- Optional username: undefined | string
  
  silence requester
- Optional comment: undefined | string
Returns Promise<Response>

request response

Static Private silenceCallbackData

silenceCallbackData(duration: string): string

- Defined in src/alertManager/AlertManager.ts:92
generates callback data to silence an alert

Parameters
- duration: string
  
  string representing time, e.g. 1h
Returns string

data encoded as string

Generated using TypeDoc