IafNotification

Use the IafNotification API to create and manage notifications and associated resources

createDevice

Creates a notification device

Parameter	Required	Type	Description
device	Yes	NotificationDevice	Pass the device to create
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcCreateOptions	Service specific options.

Returns

Promise<NotificationDevice> - Created device

Examples

const subscriber =
  await IafNotification.createDevice(
    {
      _owner: {
          _irn: "passportsvc:user:myuserid"
      },
      _transport: "EMAIL",
      _address: "test@example.com"
    },
    ctx
  );

createGroup

Creates a notification group

Parameter	Required	Type	Description
group	Yes	NotificationGroup	Pass the group to create
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcCreateOptions	Service specific options.

Returns

Promise<NotificationGroup> - Created group

Examples

const group =
  await IafNotification.createGroup(
    {
      _name: "System",
      _description: "System notification group"
      _namespaces: project._namespaces
    },
    ctx
  );

createSender

Creates a notification sender

Parameter	Required	Type	Description
sender	Yes	NotificationSender	Pass the sender to create
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcCreateOptions	Service specific options.

Returns

Promise<NotificationSender> - Created sender

Examples

const sender =
  await IafNotification.createSender(
    {
      _name: "System",
      _description: "System notification sender"
      _namespaces: project._namespaces
    },
    ctx
  );

createSubscription

Creates a notification subscription

Parameter	Required	Type	Description
subscription	Yes	NotificationSubscription	Pass the subscription to create
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcCreateOptions	Service specific options.

Returns

Promise<NotificationSubscription> - Created subscription

Examples

const subscription =
  await IafNotification.createSubscription(
    {
      _namespaces: project._namespaces,
      _group: {
          _id: "<group id>"
      },
      _device: {
          _id: "<device id>"
      }
    },
    ctx
  );

createTemplate

Creates a notification template

Parameter	Required	Type	Description
template	Yes	NotificationTemplate	Pass the template to create
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcCreateOptions	Service specific options.

Returns

Promise<NotificationTemplate> - Created template

Examples

const template =
  await IafNotification.createTemplate(
    {
      _namespaces: project._namespaces,
      _transport: "EMAIL",
      _format: "VELOCITY",
    },
    ctx
  );

createTrigger

Creates a notification trigger

Parameter	Required	Type	Description
trigger	Yes	NotificationTrigger	Pass the template to create
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcCreateOptions	Service specific options.

Returns

Promise<NotificationTrigger> - Created trigger

Examples

const trigger =
  await IafNotification.createTrigger(
    {
      _namespaces: project._namespaces,
      _type: "EVENT"
    },
    ctx
  );

deleteDevice

Deletes a notification device

Parameter	Required	Type	Description
id	Yes	String	The id of the device to delete
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcDeleteOptions	Service specific options.

Returns

Promise<void> - Empty promise

Examples

await IafNotification.deleteDevice(
  deviceId,
  ctx
);

deleteGroup

Deletes a notification group

Parameter	Required	Type	Description
id	Yes	String	The id of the group to delete
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcDeleteOptions	Service specific options.

Returns

Promise<void> - Empty promise

Examples

await IafNotification.deleteGroup(
  groupId,
  ctx
);

deleteSender

Deletes a notification sender

Parameter	Required	Type	Description
id	Yes	String	The id of the sender to delete
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcDeleteOptions	Service specific options.

Returns

Promise<void> - Empty promise

Examples

await IafNotification.deleteSender(
  senderId,
  ctx
);

deleteSubscription

Deletes a notification subscription

Parameter	Required	Type	Description
id	Yes	String	The id of the subscription to delete
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcDeleteOptions	Service specific options.

Returns

Promise<void> - Empty promise

Examples

await IafNotification.deleteSubscription(
  subscriptionId,
  ctx
);

deleteTemplate

Deletes a notification template

Parameter	Required	Type	Description
id	Yes	String	The id of the template to delete
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcDeleteOptions	Service specific options.

Returns

Promise<void> - Empty promise

Examples

await IafNotification.deleteTemplate(
  templateId,
  ctx
);

deleteTrigger

Deletes a notification trigger

Parameter	Required	Type	Description
id	Yes	String	The id of the trigger to delete
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcDeleteOptions	Service specific options.

Returns

Promise<void> - Empty promise

Examples

await IafNotification.deleteTrigger(
  triggerId,
  ctx
);

getDevice

Gets a notification device

Parameter	Required	Type	Description
id	Yes	String	The id of the device to get
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcGetOptions	Service specific options.

Returns

Promise<NotificationDevice> - The subscriber

Examples

const subscriber =
  await IafNotification.getDevice(
    deviceId,
    ctx
  );

getGroup

Gets a notification group

Parameter	Required	Type	Description
id	Yes	String	The id of the group to get
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcGetOptions	Service specific options.

Returns

Promise<NotificationGroup> - Updated group

Examples

const group =
  await IafNotification.getGroup(
    groupId,
    ctx
  );

getSender

Gets a notification sender

Parameter	Required	Type	Description
id	Yes	String	The id of the sender to get
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcGetOptions	Service specific options.

Returns

Promise<NotificationSender> - The sender

Examples

const sender =
  await IafNotification.getSender(
    senderId,
    ctx
  );

getSubscription

Gets a notification subscription

Parameter	Required	Type	Description
id	Yes	String	The id of the subscription to get
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcGetOptions	Service specific options.

Returns

Promise<NotificationSubscription> - The subscription

Examples

const subscription =
  await IafNotification.getSubscription(
    subscriptionId,
    ctx
  );

getTemplate

Gets a notification template

Parameter	Required	Type	Description
id	Yes	String	The id of the template to get
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcGetOptions	Service specific options.

Returns

Promise<NotificationTemplate> - The template

Examples

const template =
  await IafNotification.getTemplate(
    templateId,
    ctx
  );

getTrigger

Gets a notification trigger

Parameter	Required	Type	Description
id	Yes	String	The id of the trigger to get
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcGetOptions	Service specific options.

Returns

Promise<NotificationTrigger> - The template

Examples

const trigger =
  await IafNotification.getTrigger(
    triggerId,
    ctx
  );

listDevices

List notification devices

Parameter	Required	Type	Description
query	No	NotificationDeviceQuery	The query.
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcListOptions	Service specific options.

Returns

Promise<Page<NotificationDevice>> - Matched devices

Examples

const subscribers =
  await IafNotification.listDevices(
    {
      owner: {
          irn: "passportsvc:user:myuserid"
      },
    },
    ctx
  );

listGroups

List notification groups

Parameter	Required	Type	Description
query	No	NotificationGroupQuery	The query.
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcListOptions	Service specific options.

Returns

Promise<Page<NotificationGroup>> - Updated group

Examples

const groups =
  await IafNotification.listGroups(
    {
       namespaces: ["ns1"]
    },
    ctx
  );

listNotifications

List notification history

Parameter	Required	Type	Description
query	No	NotificationNotificationQuery	The query.
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcListOptions	Service specific options.

Returns

Promise<Page<NotificationNotification>> - Matched triggers

Examples

const notifications =
  await IafNotification.listNotifications(
    {
      namespaces: ["ns1"],
      owner: {
          irn: "passportsvc:user:myuserid"
      },
    },
    ctx
  );

listSenders

List notification senders

Parameter	Required	Type	Description
query	No	NotificationSenderQuery	The query.
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcListOptions	Service specific options.

Returns

Promise<Page<NotificationSender>> - Matched senders

Examples

const senders =
  await IafNotification.listSenders(
    {
       namespaces: ["ns1"]
    },
    ctx
  );

listSubscriptions

List notification subscriptions

Parameter	Required	Type	Description
query	No	NotificationSubscriptionQuery	The query.
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcListOptions	Service specific options.

Returns

Promise<Page<NotificationSubscription>> - Matched subscriptions

Examples

const subscriptions =
  await IafNotification.listSubscriptions(
    {
       namespaces: ["ns1"]
    },
    ctx
  );

listTemplates

List notification templates

Parameter	Required	Type	Description
query	No	NotificationTemplateQuery	The query.
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcListOptions	Service specific options.

Returns

Promise<Page<NotificationTemplate>> - Matched templates

Examples

const templates =
  await IafNotification.listTemplates(
    {
       namespaces: ["ns1"]
    },
    ctx
  );

listTriggers

List notification triggers

Parameter	Required	Type	Description
query	No	NotificationTriggerQuery	The query.
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcListOptions	Service specific options.

Returns

Promise<Page<NotificationTrigger>> - Matched triggers

Examples

const triggers =
  await IafNotification.listTriggers(
    {
       namespaces: ["ns1"]
    },
    ctx
  );

updateGroup

Updates a notification group

Parameter	Required	Type	Description
id	Yes	String	The id of the group to update
group	Yes	NotificationGroup	Values to update
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcUpdateOptions	Service specific options.

Returns

Promise<NotificationGroup> - Updated group

Examples

const group =
  await IafNotification.updateGroup(
    groupId,
    {
      _description: "System notification group"
    },
    ctx
  );

updateSender

Updates a notification sender

Parameter	Required	Type	Description
id	Yes	String	The id of the sender to update
sender	Yes	NotificationSender	Values to update
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcUpdateOptions	Service specific options.

Returns

Promise<NotificationSender> - Updated sender

Examples

const sender =
  await IafNotification.updateSender(
    senderId,
    {
      _description: "System notification sender"
    },
    ctx
  );

updateTemplate

Updates a notification template

Parameter	Required	Type	Description
id	Yes	String	The id of the template to update
template	Yes	NotificationTemplate	Values to update
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcUpdateOptions	Service specific options.

Returns

Promise<NotificationTemplate> - Updated template

Examples

const template =
  await IafNotification.updateTemplate(
    templateId,
    {
     _body: "template body"
    },
    ctx
  );

updateTrigger

Updates a notification trigger

Parameter	Required	Type	Description
id	Yes	String	The id of the trigger to update
trigger	Yes	NotificationTrigger	Values to update
ctx	No	Ctx	Context, such as authorization token requirements, namespaces, or session storage.
options	No	NotificationSvcUpdateOptions	Service specific options.

Returns

Promise<NotificationTrigger> - Updated trigger

Examples

const trigger =
  await IafNotification.updateTrigger(
    triggerId,
    {
    },
    ctx
  );