Class NotificationsManager

Hierarchy

CreateDestroyStartStop
- NotificationsManager

Index

Constructors

Properties

[initLock] acl db inboxNotificationIdGenerator keyRing logger messageCap nodeManager notificationsManagerDbPath notificationsManagerInboxDbPath notificationsManagerOutboxDbPath outboxNotificationIdGenerator sendNotificationHandler sendNotificationHandlerId sendNotificationRetries sendNotificationRetryIntervalTimeMax sendNotificationRetryIntervalTimeMin taskManager

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Constructors

constructor

new NotificationsManager(__namedParameters): NotificationsManager
Parameters
- __namedParameters: {
      acl: ACL;
      db: DB;
      keyRing: KeyRing;
      logger: Logger;
      messageCap: number;
      nodeManager: NodeManager;
      sendNotificationRetries: number;
      sendNotificationRetryIntervalTimeMax: number;
      sendNotificationRetryIntervalTimeMin: number;
      taskManager: TaskManager;
  }
  - acl: ACL
  - db: DB
  - keyRing: KeyRing
  - logger: Logger
  - messageCap: number
  - nodeManager: NodeManager
  - sendNotificationRetries: number
  - sendNotificationRetryIntervalTimeMax: number
  - sendNotificationRetryIntervalTimeMin: number
  - taskManager: TaskManager
Returns NotificationsManager
Inherited from CreateDestroyStartStop.constructor
- Defined in src/notifications/NotificationsManager.ts:216

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` acl

acl: ACL

`Protected` db

db: DB

`Protected` inboxNotificationIdGenerator

inboxNotificationIdGenerator: (() => NotificationId)

Type declaration

- (): NotificationId
- Returns NotificationId

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

`Protected` messageCap

messageCap: number

`Protected` nodeManager

nodeManager: NodeManager

`Protected` notificationsManagerDbPath

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

`Protected` notificationsManagerInboxDbPath

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

Inbox Notifications NotificationsManager/inbox/{NotificationId} -> {NotificationDB}

`Protected` notificationsManagerOutboxDbPath

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

Outbox Notifications NotificationsManager/outbox/{NotificationId} -> {NotificationDB}

`Protected` outboxNotificationIdGenerator

outboxNotificationIdGenerator: (() => NotificationId)

Type declaration

- (): NotificationId
- Returns NotificationId

`Protected` sendNotificationHandler

sendNotificationHandler: TaskHandler = ...

`Readonly` sendNotificationHandlerId

sendNotificationHandlerId: TaskHandlerId = ...

`Protected` sendNotificationRetries

sendNotificationRetries: number

`Protected` sendNotificationRetryIntervalTimeMax

sendNotificationRetryIntervalTimeMax: number

`Protected` sendNotificationRetryIntervalTimeMin

sendNotificationRetryIntervalTimeMin: number

`Protected` taskManager

taskManager: TaskManager

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

clearInboxNotifications

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

clearOutboxNotifications

clearOutboxNotifications(tran?): Promise<void>
Clears the pending outbox notifications
Parameters
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/notifications/NotificationsManager.ts:573

destroy

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

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:730

`Protected` getInboxNotificationIds

getInboxNotificationIds(__namedParameters): AsyncGenerator<NotificationId, any, unknown>
Parameters
- __namedParameters: {
      limit?: number;
      order?: "asc" | "desc";
      seek?: number | Date | NotificationId;
      seekEnd?: number | Date | NotificationId;
      tran: DBTransaction;
      unread?: boolean;
  }
  - Optional limit?: number
  - Optional order?: "asc" | "desc"
  - Optional seek?: number | Date | NotificationId
  - Optional seekEnd?: number | Date | NotificationId
  - tran: DBTransaction
  - Optional unread?: boolean
Returns AsyncGenerator<NotificationId, any, unknown>
- Defined in src/notifications/NotificationsManager.ts:790

`Protected` getInboxNotifications

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

`Protected` getOutboxNotificationIds

getOutboxNotificationIds(__namedParameters): AsyncGenerator<NotificationId, any, unknown>
Parameters
- __namedParameters: {
      limit?: number;
      order?: "asc" | "desc";
      seek?: number | Date | NotificationId;
      seekEnd?: number | Date | NotificationId;
      tran: DBTransaction;
  }
  - Optional limit?: number
  - Optional order?: "asc" | "desc"
  - Optional seek?: number | Date | NotificationId
  - Optional seekEnd?: number | Date | NotificationId
  - tran: DBTransaction
Returns AsyncGenerator<NotificationId, any, unknown>
- Defined in src/notifications/NotificationsManager.ts:418

getOutboxNotificationTaskInfoById

getOutboxNotificationTaskInfoById(notificationId, tran?): Promise<undefined | TaskInfo>
Parameters
- notificationId: NotificationId
- Optional tran: DBTransaction
Returns Promise<undefined | TaskInfo>
- Defined in src/notifications/NotificationsManager.ts:526

`Protected` readInboxNotificationById

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

readInboxNotifications

readInboxNotifications(__namedParameters?): AsyncGenerator<Notification, any, unknown>
Read a notification
Parameters
- __namedParameters: {
      limit?: number;
      order?: "asc" | "desc";
      seek?: number | Date | NotificationId;
      seekEnd?: number | Date | NotificationId;
      tran?: DBTransaction;
      unread?: boolean;
  } = {}
  - Optional limit?: number
  - Optional order?: "asc" | "desc"
  - Optional seek?: number | Date | NotificationId
  - Optional seekEnd?: number | Date | NotificationId
  - Optional tran?: DBTransaction
  - Optional unread?: boolean
Returns AsyncGenerator<Notification, any, unknown>
- Defined in src/notifications/NotificationsManager.ts:679

`Protected` readOutboxNotificationById

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

readOutboxNotifications

readOutboxNotifications(__namedParameters?): AsyncGenerator<Notification, any, unknown>
Read pending notifications in the outbox.
Parameters
- __namedParameters: {
      limit?: number;
      order?: "asc" | "desc";
      seek?: number | Date | NotificationId;
      seekEnd?: number | Date | NotificationId;
      tran?: DBTransaction;
  } = {}
  - Optional limit?: number
  - Optional order?: "asc" | "desc"
  - Optional seek?: number | Date | NotificationId
  - Optional seekEnd?: number | Date | NotificationId
  - Optional tran?: DBTransaction
Returns AsyncGenerator<Notification, any, unknown>
- Defined in src/notifications/NotificationsManager.ts:487

receiveNotification

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

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

removeInboxNotification

removeInboxNotification(messageId, tran?): Promise<void>
Parameters
- messageId: NotificationId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/notifications/NotificationsManager.ts:872

removeOutboxNotification

removeOutboxNotification(notificationId, tran?): Promise<void>
Parameters
- notificationId: NotificationId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/notifications/NotificationsManager.ts:586

sendNotification

sendNotification(__namedParameters, tran?): Promise<{
notificationId: NotificationId;
sendP: Promise<void>;
}>
Send a notification to another node The data parameter must match one of the NotificationData types outlined in ./types
Parameters
- __namedParameters: {
      data: NotificationData;
      nodeId: NodeId;
      retries?: number;
      retryIntervalTimeMax?: number;
      retryIntervalTimeMin?: number;
  }
  - data: NotificationData
  - nodeId: NodeId
  - Optional retries?: number
  - Optional retryIntervalTimeMax?: number
  - Optional retryIntervalTimeMin?: number
- Optional tran: DBTransaction
Returns Promise<{
notificationId: NotificationId;
sendP: Promise<void>;
}>
- Defined in src/notifications/NotificationsManager.ts:318

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:253

stop

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

`Static` createNotificationsManager

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

Class NotificationsManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { acl: ACL; db: DB; keyRing: KeyRing; logger: Logger; messageCap: number; nodeManager: NodeManager; sendNotificationRetries: number; sendNotificationRetryIntervalTimeMax: number; sendNotificationRetryIntervalTimeMin: number; taskManager: TaskManager; }

acl: ACL

db: DB

keyRing: KeyRing

logger: Logger

messageCap: number

nodeManager: NodeManager

sendNotificationRetries: number

sendNotificationRetryIntervalTimeMax: number

sendNotificationRetryIntervalTimeMin: number

taskManager: TaskManager

Returns NotificationsManager

Properties

Readonly [initLock]

Protected acl

Protected db

Protected inboxNotificationIdGenerator

Type declaration

Returns NotificationId

Protected keyRing

Protected logger

Protected messageCap

Protected nodeManager

Protected notificationsManagerDbPath

Protected notificationsManagerInboxDbPath

Protected notificationsManagerOutboxDbPath

Protected outboxNotificationIdGenerator

Type declaration

Returns NotificationId

Protected sendNotificationHandler

Readonly sendNotificationHandlerId

Protected sendNotificationRetries

Protected sendNotificationRetryIntervalTimeMax

Protected sendNotificationRetryIntervalTimeMin

Protected taskManager

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

clearInboxNotifications

Parameters

Optional tran: DBTransaction

Returns Promise<void>

clearOutboxNotifications

Parameters

Optional tran: DBTransaction

Returns Promise<void>

__namedParameters: {
acl: ACL;
db: DB;
keyRing: KeyRing;
logger: Logger;
messageCap: number;
nodeManager: NodeManager;
sendNotificationRetries: number;
sendNotificationRetryIntervalTimeMax: number;
sendNotificationRetryIntervalTimeMin: number;
taskManager: TaskManager;
}

`Readonly` [initLock]

`Protected` acl

`Protected` db

`Protected` inboxNotificationIdGenerator

`Protected` keyRing

`Protected` logger

`Protected` messageCap

`Protected` nodeManager

`Protected` notificationsManagerDbPath

`Protected` notificationsManagerInboxDbPath

`Protected` notificationsManagerOutboxDbPath

`Protected` outboxNotificationIdGenerator

`Protected` sendNotificationHandler

`Readonly` sendNotificationHandlerId

`Protected` sendNotificationRetries

`Protected` sendNotificationRetryIntervalTimeMax

`Protected` sendNotificationRetryIntervalTimeMin

`Protected` taskManager

`Optional` options: boolean | AddEventListenerOptions

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Protected` getInboxNotificationIds

__namedParameters: {
limit?: number;
order?: "asc" | "desc";
seek?: number | Date | NotificationId;
seekEnd?: number | Date | NotificationId;
tran: DBTransaction;
unread?: boolean;
}

`Optional` limit?: number

`Optional` order?: "asc" | "desc"

`Optional` seek?: number | Date | NotificationId

`Optional` seekEnd?: number | Date | NotificationId

`Optional` unread?: boolean

`Protected` getInboxNotifications

`Protected` getOutboxNotificationIds

__namedParameters: {
limit?: number;
order?: "asc" | "desc";
seek?: number | Date | NotificationId;
seekEnd?: number | Date | NotificationId;
tran: DBTransaction;
}

`Optional` limit?: number

`Optional` order?: "asc" | "desc"

`Optional` seek?: number | Date | NotificationId

`Optional` seekEnd?: number | Date | NotificationId

`Optional` tran: DBTransaction

`Protected` readInboxNotificationById

__namedParameters: {
limit?: number;
order?: "asc" | "desc";
seek?: number | Date | NotificationId;
seekEnd?: number | Date | NotificationId;
tran?: DBTransaction;
unread?: boolean;
} = {}

`Optional` limit?: number

`Optional` order?: "asc" | "desc"

`Optional` seek?: number | Date | NotificationId

`Optional` seekEnd?: number | Date | NotificationId

`Optional` tran?: DBTransaction

`Optional` unread?: boolean

`Protected` readOutboxNotificationById

__namedParameters: {
limit?: number;
order?: "asc" | "desc";
seek?: number | Date | NotificationId;
seekEnd?: number | Date | NotificationId;
tran?: DBTransaction;
} = {}

`Optional` limit?: number

`Optional` order?: "asc" | "desc"

`Optional` seek?: number | Date | NotificationId

`Optional` seekEnd?: number | Date | NotificationId

`Optional` tran?: DBTransaction