Class PushMessageHelper

Index

Constructors

Properties

apns? apnsClient? badge? firebase? firebaseApp? icon? notificationSubs state syncSubs vapidEmail? vapidPrivateKey? vapidPublicKey?

Methods

pushNotification pushSync queuePushSync refreshInstance createInstance

Constructors

constructor

new PushMessageHelper(config: PushMessageHelperConfig): PushMessageHelper
normal first init
Parameters
- config: PushMessageHelperConfig
  PushMessageHelper configuration
Returns PushMessageHelper
- Defined in saltcorn-data/models/internal/push_message_helper.ts:174

Properties

`Optional`apns

apns?: {
    appId: string;
    signingKey: string;
    signingKeyId: string;
    teamId: string;
}

`Optional`apnsClient

apnsClient?: ApnsClient

`Optional`badge

badge?: string

`Optional`firebase

firebase?: { jsonContent: any; jsonPath: string }

`Optional`firebaseApp

firebaseApp?: App | null

`Optional`icon

icon?: string

notificationSubs

notificationSubs: Record<string, (WebPushSubscription | MobileSubscription)[]>

state

state: any

syncSubs

syncSubs: Record<string, MobileSubscription[]>

`Optional`vapidEmail

vapidEmail?: string

`Optional`vapidPrivateKey

vapidPrivateKey?: string

`Optional`vapidPublicKey

vapidPublicKey?: string

Methods

pushNotification

pushNotification(notification: Notification): Promise<void>
Sends a notification to all subscriptions.
Parameters
- notification: Notification
  The notification to send.
Returns Promise<void>
- Defined in saltcorn-data/models/internal/push_message_helper.ts:229

pushSync

pushSync(): Promise<void>
Sends a sync push to all sync subscriptions. APNS or FCM

Returns Promise<void>
- Defined in saltcorn-data/models/internal/push_message_helper.ts:294

queuePushSync

queuePushSync(): boolean
queue a sync or do nothing if already queued

Returns boolean
true if queued
- Defined in saltcorn-data/models/internal/push_message_helper.ts:267

refreshInstance

refreshInstance(): Promise<void>
will be used when a config changes (no complete re-init)

Returns Promise<void>
- Defined in saltcorn-data/models/internal/push_message_helper.ts:203

`Static`createInstance

createInstance(): Promise<PushMessageHelper>
factory

Returns Promise<PushMessageHelper>
- Defined in saltcorn-data/models/internal/push_message_helper.ts:195