Notifications

Classes

Notifications

Typedefs

CampaignTarget : object
Task : object
Campaign : object
SenderSubscription : object
Logger : object
NotificationsOptions : object
Tag : object
Target : object
Subscribtion : object
Campaign : object
Task : object
Subscription : object
SubscriptionData : object

Kind: global class

Notifications
- new Notifications()
- instance
  - .limit : number
  - .sendLimit : number
  - .api([acl]) ⇒ object
  - .createCampaign(name, action, [data], options) ⇒ Promise.<Campaign>
  - .pushTasksToQueue(campaignTargets) ⇒ Promise.<Array.<Task>>
  - .subscribe(senderId, pageId, tag)
  - .unsubscribe(senderId, pageId, [tag], [req], [res])
  - .processMessage(event, pageId) ⇒ Promise.<{status:number}>
  - .getSubscribtions(senderId, pageId) ⇒ Promise.<Array.<string>>
  - .getSubscriptions(senderId, pageId) ⇒ Promise.<Array.<SenderSubscription>>
  - .runCampaign(campaign) ⇒ Promise.<{queued:number}>
  - .sendCampaignMessage(campaign, processor, pageId, senderId, [data]) ⇒ Promise.<{status: number}>
- static
  - .Notifications
    - new Notifications(notificationStorage, options)

new Notifications()

Experimental notifications service

notifications.limit : `number`

Kind: instance property of Notifications

notifications.sendLimit : `number`

Kind: instance property of Notifications

notifications.api([acl]) ⇒ `object`

API Factory

Kind: instance method of Notifications
Returns: object - - the graphql api object

Param	Type	Default	Description
[acl]	`Array.<string>` \| `function`		limit api to array of groups or use auth function

notifications.createCampaign(name, action, [data], options) ⇒ `Promise.<Campaign>`

Upsert the campaign If the campaing does not exists add new. Otherwise, update it.

Kind: instance method of Notifications

Param	Type	Description
name	`string`
action	`string`
[data]	`object`
options	`object`	use { id: '...' } to make campaign accessible from code

notifications.pushTasksToQueue(campaignTargets) ⇒ `Promise.<Array.<Task>>`

Add tasks to process by queue

Kind: instance method of Notifications

Param	Type
campaignTargets	`Array.<CampaignTarget>`

notifications.subscribe(senderId, pageId, tag)

Subscribe user under certain tag

Kind: instance method of Notifications

Param	Type
senderId	`string`
pageId	`string`
tag	`string`

notifications.unsubscribe(senderId, pageId, [tag], [req], [res])

Unsubscribe user from certain tag or from all tags

Kind: instance method of Notifications

Param	Type	Default
senderId	`string`
pageId	`string`
[tag]	`string`	`null`
[req]	`object`
[res]	`object`

notifications.processMessage(event, pageId) ⇒ `Promise.<{status:number}>`

Preprocess message - for read and delivery

Kind: instance method of Notifications

Param	Type
event	`object`
pageId	`string`

notifications.getSubscribtions(senderId, pageId) ⇒ `Promise.<Array.<string>>`

Get user subscribtions

Kind: instance method of Notifications

Param	Type
senderId	`string`
pageId	`string`

notifications.getSubscriptions(senderId, pageId) ⇒ `Promise.<Array.<SenderSubscription>>`

Get user subscribtions

Kind: instance method of Notifications

Param	Type
senderId	`string`
pageId	`string`

notifications.runCampaign(campaign) ⇒ `Promise.<{queued:number}>`

Run the campaign now (push tasks into the queue)

Kind: instance method of Notifications

Param	Type
campaign	`object`

notifications.sendCampaignMessage(campaign, processor, pageId, senderId, [data]) ⇒ `Promise.<{status: number}>`

Sends the message directly (without queue) and records it's delivery status at campaign stats

Kind: instance method of Notifications

Param	Type	Description
campaign	`object`	campaign
processor	`object`	channel processor instance
pageId	`string`	page
senderId	`string`	user
[data]	`object`	override the data of campaign

Example

const campaign = await notifications
    .createCampaign('Custom campaign', 'camp-action', {}, { id: 'custom-campaign' });

await notifications.sendCampaignMessage(campaign, channel, pageId, senderId);

Notifications.Notifications

Kind: static class of Notifications