Class NotificationsManager

Hierarchy

CreateDestroyStartStop
- NotificationsManager

Constructors

constructor

new NotificationsManager(__namedParameters): NotificationsManager
Parameters
- __namedParameters: {
      acl: ACL;
      db: DB;
      keyRing: KeyRing;
      logger: Logger;
      messageCap: number;
      nodeConnectionManager: NodeConnectionManager;
      nodeManager: NodeManager;
  }
  - acl: ACL
  - db: DB
  - keyRing: KeyRing
  - logger: Logger
  - messageCap: number
  - nodeConnectionManager: NodeConnectionManager
  - nodeManager: NodeManager
Returns NotificationsManager
Inherited from CreateDestroyStartStop.constructor
- Defined in src/notifications/NotificationsManager.ts:101

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` acl

acl: ACL

`Protected` db

db: DB

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

`Protected` messageCap

messageCap: number

`Protected` nodeConnectionManager

nodeConnectionManager: NodeConnectionManager

`Protected` nodeManager

nodeManager: NodeManager

`Protected` notificationIdGenerator

notificationIdGenerator: (() => NotificationId)

Type declaration

- (): NotificationId
- Returns NotificationId

`Protected` notificationsDbPath

notificationsDbPath: readonly (string | Buffer)[] = ...

Top level stores MESSAGE_COUNT_KEY -> number (of messages)

`Protected` notificationsMessageCounterDbPath

notificationsMessageCounterDbPath: readonly (string | Buffer)[] = ...

`Protected` notificationsMessagesDbPath

notificationsMessagesDbPath: readonly (string | Buffer)[] = ...

Messages stores NotificationId -> string (message)

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

clearNotifications

clearNotifications(tran?): Promise<void>
Removes all notifications
Parameters
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/notifications/NotificationsManager.ts:316

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.destroy
- Defined in src/notifications/NotificationsManager.ts:158

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

findGestaltInvite

findGestaltInvite(fromNode, tran?): Promise<undefined | Notification>
Linearly searches for a GestaltInvite notification from the supplied NodeId. Returns the notification if found.
Parameters
- fromNode: NodeId
- Optional tran: DBTransaction
Returns Promise<undefined | Notification>
- Defined in src/notifications/NotificationsManager.ts:292

`Protected` getNotificationIds

getNotificationIds(type, tran): Promise<NotificationId[]>
Parameters
- type: "all" | "unread"
- tran: DBTransaction
Returns Promise<NotificationId[]>
- Defined in src/notifications/NotificationsManager.ts:353

`Protected` getNotifications

getNotifications(type, tran): Promise<Notification[]>
Parameters
- type: "all" | "unread"
- tran: DBTransaction
Returns Promise<Notification[]>
- Defined in src/notifications/NotificationsManager.ts:376

`Protected` getOldestNotificationId

getOldestNotificationId(tran): Promise<undefined | NotificationId>
Parameters
- tran: DBTransaction
Returns Promise<undefined | NotificationId>
- Defined in src/notifications/NotificationsManager.ts:396

`Protected` readNotificationById

readNotificationById(notificationId, tran): Promise<undefined | Notification>
Parameters
- notificationId: NotificationId
- tran: DBTransaction
Returns Promise<undefined | Notification>
- Defined in src/notifications/NotificationsManager.ts:334

readNotifications

readNotifications(__namedParameters?): Promise<Notification[]>
Read a notification
Parameters
- __namedParameters: {
      number?: number | "all";
      order?: "newest" | "oldest";
      tran?: DBTransaction;
      unread?: boolean;
  } = {}
  - Optional number?: number | "all"
  - Optional order?: "newest" | "oldest"
  - Optional tran?: DBTransaction
  - Optional unread?: boolean
Returns Promise<Notification[]>
- Defined in src/notifications/NotificationsManager.ts:245

receiveNotification

receiveNotification(notification, tran?): Promise<void>
Receive a notification
Parameters
- notification: Notification
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/notifications/NotificationsManager.ts:197

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

`Protected` removeNotification

removeNotification(messageId, tran): Promise<void>
Parameters
- messageId: NotificationId
- tran: DBTransaction
Returns Promise<void>
- Defined in src/notifications/NotificationsManager.ts:406

sendNotification

sendNotification(nodeId, data): Promise<void>
Send a notification to another node The data parameter must match one of the NotificationData types outlined in ./types
Parameters
- nodeId: NodeId
- data: NotificationData
Returns Promise<void>
- Defined in src/notifications/NotificationsManager.ts:170

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from CreateDestroyStartStop.start
- Defined in src/notifications/NotificationsManager.ts:127

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.stop
- Defined in src/notifications/NotificationsManager.ts:153

`Static` createNotificationsManager

createNotificationsManager(__namedParameters): Promise<NotificationsManager>
Parameters
- __namedParameters: {
      acl: ACL;
      db: DB;
      fresh?: boolean;
      keyRing: KeyRing;
      logger?: Logger;
      messageCap?: number;
      nodeConnectionManager: NodeConnectionManager;
      nodeManager: NodeManager;
  }
  - acl: ACL
  - db: DB
  - Optional fresh?: boolean
  - keyRing: KeyRing
  - Optional logger?: Logger
  - Optional messageCap?: number
  - nodeConnectionManager: NodeConnectionManager
  - nodeManager: NodeManager
Returns Promise<NotificationsManager>
- Defined in src/notifications/NotificationsManager.ts:40

Class NotificationsManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { acl: ACL; db: DB; keyRing: KeyRing; logger: Logger; messageCap: number; nodeConnectionManager: NodeConnectionManager; nodeManager: NodeManager; }

acl: ACL

db: DB

keyRing: KeyRing

logger: Logger

messageCap: number

nodeConnectionManager: NodeConnectionManager

nodeManager: NodeManager

Returns NotificationsManager

Properties

Readonly [initLock]

Protected acl

Protected db

Protected keyRing

Protected logger

Protected messageCap

Protected nodeConnectionManager

Protected nodeManager

Protected notificationIdGenerator

Type declaration

Returns NotificationId

Protected notificationsDbPath

Protected notificationsMessageCounterDbPath

Protected notificationsMessagesDbPath

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

clearNotifications

Parameters

Optional tran: DBTransaction

Returns Promise<void>

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

findGestaltInvite

Parameters

fromNode: NodeId

Optional tran: DBTransaction

Returns Promise<undefined | Notification>

Protected getNotificationIds

Parameters

type: "all" | "unread"

tran: DBTransaction

__namedParameters: {
acl: ACL;
db: DB;
keyRing: KeyRing;
logger: Logger;
messageCap: number;
nodeConnectionManager: NodeConnectionManager;
nodeManager: NodeManager;
}

`Readonly` [initLock]

`Protected` acl

`Protected` db

`Protected` keyRing

`Protected` logger

`Protected` messageCap

`Protected` nodeConnectionManager

`Protected` nodeManager

`Protected` notificationIdGenerator

`Protected` notificationsDbPath

`Protected` notificationsMessageCounterDbPath

`Protected` notificationsMessagesDbPath

`Optional` options: boolean | AddEventListenerOptions

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Protected` getNotificationIds

`Protected` getNotifications

`Protected` getOldestNotificationId

`Protected` readNotificationById

__namedParameters: {
number?: number | "all";
order?: "newest" | "oldest";
tran?: DBTransaction;
unread?: boolean;
} = {}

`Optional` number?: number | "all"

`Optional` order?: "newest" | "oldest"

`Optional` tran?: DBTransaction

`Optional` unread?: boolean

`Optional` tran: DBTransaction

`Optional` options: boolean | EventListenerOptions

`Protected` removeNotification

__namedParameters: {
fresh?: boolean;
} = {}

`Optional` fresh?: boolean

`Static` createNotificationsManager

__namedParameters: {
acl: ACL;
db: DB;
fresh?: boolean;
keyRing: KeyRing;
logger?: Logger;
messageCap?: number;
nodeConnectionManager: NodeConnectionManager;
nodeManager: NodeManager;
}

`Optional` fresh?: boolean

`Optional` logger?: Logger

`Optional` messageCap?: number