Class NotificationHandler

Hierarchy

NotificationHandler

Implements

INotificationHandler

Constructors

`Private` constructor

new NotificationHandler(wallet): NotificationHandler
Private
Create a NotificationHandler instance.
Parameters
- wallet: IWalletHandler
  
  Instance of WalletHandler.
Returns NotificationHandler
- Defined in src/classes/notificationHandler.ts:28

Properties

`Private` `Readonly` qH

qH: IQueryHandler

`Private` `Readonly` walletRef

walletRef: IWalletHandler

Methods

broadcastMakeCounter

broadcastMakeCounter(): Promise<void>
Initializes Notification system for user. Wraps makeCounter().

Returns Promise<void>
Implementation of INotificationHandler.broadcastMakeCounter
- Defined in src/classes/notificationHandler.ts:137

checkNotificationInit

checkNotificationInit(forAddress): Promise<boolean>
Check if makeCounter() or broadcastMakeCounter() has been run for target address.
Parameters
- forAddress: string
  
  Bech32 address to check.
Returns Promise<boolean>
Implementation of INotificationHandler.checkNotificationInit
- Defined in src/classes/notificationHandler.ts:213

getAllNotificationCounters

getAllNotificationCounters(): Promise<QueryAllNotiCounterResponse>
Check Notification count for all addresses.

Returns Promise<QueryAllNotiCounterResponse>
Implementation of INotificationHandler.getAllNotificationCounters
- Defined in src/classes/notificationHandler.ts:232

getAllNotifications

getAllNotifications(): Promise<QueryAllNotificationsResponse>
Get all Notifications.

Returns Promise<QueryAllNotificationsResponse>
Implementation of INotificationHandler.getAllNotifications
- Defined in src/classes/notificationHandler.ts:172

`Private` getBaseNotiCounter

getBaseNotiCounter(forAddress): Promise<IBaseNotiResponse>
Private
Check Notification count for target address.
Parameters
- forAddress: string
  
  Bech32 address for target.
Returns Promise<IBaseNotiResponse>
- Defined in src/classes/notificationHandler.ts:353

getNotification

getNotification(forAddress, index): Promise<QueryGetNotificationsResponse>
Get target Notification for target receiver.
Parameters
- forAddress: string
  
  Bech32 address of receiver of Notification.
- index: number
  
  Index of Notification to retrieve.
Returns Promise<QueryGetNotificationsResponse>
Implementation of INotificationHandler.getNotification
- Defined in src/classes/notificationHandler.ts:156

getNotificationCounter

getNotificationCounter(forAddress): Promise<QueryGetNotiCounterResponse>
Check Notification count for target address. Wrapper for getBaseNotiCounter().
Parameters
- forAddress: string
  
  Bech32 address to check.
Returns Promise<QueryGetNotiCounterResponse>
Implementation of INotificationHandler.getNotificationCounter
- Defined in src/classes/notificationHandler.ts:222

getSingleAddressNotifications

getSingleAddressNotifications(forAddress): Promise<Notifications[]>
Get all Notifications for target receiver.
Parameters
- forAddress: string
  
  Bech32 address of receiver of Notification.
Returns Promise<Notifications[]>
Implementation of INotificationHandler.getSingleAddressNotifications
- Defined in src/classes/notificationHandler.ts:190

makeAddShareNoti

makeAddShareNoti(address): Promise<EncodeObject>
Create sharing added Notification entry. Wraps makeStandardizedShareNotification().
Parameters
- address: string
  
  Bech32 address of Notification target.
Returns Promise<EncodeObject>
Implementation of INotificationHandler.makeAddShareNoti
- Defined in src/classes/notificationHandler.ts:277

makeBlockedSender

makeBlockedSender(sender): EncodeObject
Blocks target address from sending Notifications to user.
Parameters
- sender: string
  
  Bech32 address to block.
Returns EncodeObject
Implementation of INotificationHandler.makeBlockedSender
- Defined in src/classes/notificationHandler.ts:121

makeCounter

makeCounter(): EncodeObject
Initializes Notification system for user.

Returns EncodeObject
Implementation of INotificationHandler.makeCounter
- Defined in src/classes/notificationHandler.ts:107

makeNotification

makeNotification(notification, address): EncodeObject
Create and send Notification to target user.
Parameters
- notification: string
  
  Notification content.
- address: string
  
  Bech32 address of recipient.
Returns EncodeObject
Implementation of INotificationHandler.makeNotification
- Defined in src/classes/notificationHandler.ts:50

makeNotificationDeletion

makeNotificationDeletion(): EncodeObject
Deletes all Notifications created by user.

Returns EncodeObject
Implementation of INotificationHandler.makeNotificationDeletion
- Defined in src/classes/notificationHandler.ts:92

makeNotificationUpdate

makeNotificationUpdate(count, notification, address): EncodeObject
Modify previously sent Notification. Does not re-notify receiver.
Parameters
- count: number
  
  Index of Notification to update.
- notification: string
  
  New Notification content.
- address: string
  
  Bech32 address of recipient.
Returns EncodeObject
Implementation of INotificationHandler.makeNotificationUpdate
- Defined in src/classes/notificationHandler.ts:70

makeRemoveShareNoti

makeRemoveShareNoti(address): Promise<EncodeObject>
Create sharing cancelled Notification entry. Wraps makeStandardizedShareNotification().
Parameters
- address: string
  
  Bech32 address of Notification target.
Returns Promise<EncodeObject>
Implementation of INotificationHandler.makeRemoveShareNoti
- Defined in src/classes/notificationHandler.ts:303

makeStandardizedShareNotification

makeStandardizedShareNotification(type, address): Promise<EncodeObject>
Standardized general-purpose Notification Msg creator.
Parameters
- type: string
  
  Notification identification code.
- address: string
  
  Bech32 address of Notification target.
Returns Promise<EncodeObject>
Implementation of INotificationHandler.makeStandardizedShareNotification
- Defined in src/classes/notificationHandler.ts:252

makeUpdateShareNoti

makeUpdateShareNoti(address): Promise<EncodeObject>
Create sharing updated Notification entry. Wraps makeStandardizedShareNotification().
Parameters
- address: string
  
  Bech32 address of Notification target.
Returns Promise<EncodeObject>
Implementation of INotificationHandler.makeUpdateShareNoti
- Defined in src/classes/notificationHandler.ts:290

readAllMyShareNotis

readAllMyShareNotis(): Promise<IReadableNoti[]>
Query all of user's Notifications.

Returns Promise<IReadableNoti[]>
Implementation of INotificationHandler.readAllMyShareNotis
- Defined in src/classes/notificationHandler.ts:333

readMyShareNoti

readMyShareNoti(index): Promise<IReadableNoti>
Query user's Notification by index
Parameters
- index: number
  
  Index of Notification to retrieve.
Returns Promise<IReadableNoti>
Implementation of INotificationHandler.readMyShareNoti
- Defined in src/classes/notificationHandler.ts:317

`Static` trackNotification

trackNotification(wallet): Promise<INotificationHandler>
Async wrapper to create a NotificationHandler instance.
Parameters
- wallet: IWalletHandler
  
  Instance of WalletHandler.
Returns Promise<INotificationHandler>
- Instance of NotificationHandler.
- Defined in src/classes/notificationHandler.ts:38

Generated using TypeDoc