555 NTM SDK

Overview

555 Ntm SDK provides apis for subscribing for notification, deregister subscriber and deleting subscribed notification.

Feature list

SDK provides apis for

1. Register subscriber for a particular notification topic and protocol
2. Deregister subscriber
3. Delete subscribed notification
4. Setting the log level for sdk

Usage

The client can make use of this module for overall notification related task.

setConfig API

Use setConfig API to setup initial notification configuration.

import Rtc555NTM from '555-ntm-sdk';
Rtc555NTM.setConfig(config);

Parameters

Below is the config object members need to be populated:

| Property | Type | Description | |-------------------|--------|-----------------------| | token | string | iris token | | routingId | string | participant routing id| | ntmUrl | string | notification manager url|

createSubscriptions API

Use createSubscriptions API to create subscriptions for a specific topic and protocol for subscriber.

import Rtc555NTM from '555-ntm-sdk';
Rtc555NTM.createSubscriptions(subscriptions,appDomain);

Parameters

| Property | Type | Description | |-------------------|--------|-----------------------| | subscriptions | array | Array of subscription object| | appDomain | string | application domain |

Below is the subscription object need to be populated:

| Property | Type | Description | |-------------------|--------|-----------------------| | token | string | device token | | protocol | string | value like "xmpp or "fcm" or "apns" or "webn"| | topic | string | value like "pstn or "video" |

Handling Response

createSubscriptions API return a promise. If call is successful.Response will have an array of objects which contains subscriberId,protocol and array of topics,for each unique subscriberID created. Otherwise error JSON with code and reason for error.

Rtc555NTM.createSubscriptions(subscriptions,appDomain)
    .then(function (response) {
    // handle success
  })
  .catch(function (error) {
    // handle error
    console.log(error.code);
    console.log(error.reason);
  })

deleteSubscription API

Use deleteSubscription API to delete a specific subscriber subscription.

import Rtc555NTM from '555-ntm-sdk';
Rtc555NTM.deleteSubscription(subscriberId, topic,appDomain);

Parameters

| Property | Type | Description | |-------------------|--------|-----------------------| | subscriberId | string | subscriber id | | topic | string | value like "pstn or "video"| | appDomain | string | application domain |

Handling Response

deleteSubscription API return a promise. If call is successful,object having topic and subscriberId of deleted subscription will be returned as response Otherwise error JSON with code and reason for error.

Rtc555NTM.deleteSubscription(subscriberId, topic,appDomain)
    .then(function (response) {
    // handle success
    console.log(response.topic);
    console.log(response.subscriberId);
  })
  .catch(function (error) {
    // handle error
    console.log(error.code);
    console.log(error.reason);
  })

deleteAllSubscriptions API

Use deleteAllSubscriptions API to deregister a subscriber.

import Rtc555NTM from '555-ntm-sdk';
Rtc555NTM.deleteAllSubscriptions(subscriberId);

Parameters

| Property | Type | Description | |-------------------|--------|-----------------------| | subscriberId | string | subscriber id |

Handling Response

deleteAllSubscriptions API return a promise. If call is successful,deleted subscriberId will be returned as response Otherwise error JSON with code and reason for error.

Rtc555NTM.deleteAllSubscriptions(subscriberId)
    .then(function (subscriberId) {
    // handle success
    console.log(subscriberId);
  })
  .catch(function (error) {
    // handle error
    console.log(error.code);
    console.log(error.reason);
  });

setLogLevel API

Use setLogLevel API to set the log level for SDK.

import Rtc555NTM from '555-ntm-sdk';
Rtc555NTM.setLogLevel(logLevel)

Parameters

| Property | Type | Description | |-------------------|--------|-----------------------| | logLevel | integer| Value can be any one of Rtc555NTM.LogLevel values|

Below are the Rtc555NTM.LogLevel values

Rtc555NTM.LogLevel.NO_LOG Rtc555NTM.LogLevel.ERROR Rtc555NTM.LogLevel.WARNING Rtc555NTM.LogLevel.INFO Rtc555NTM.LogLevel.DEBUG Rtc555NTM.LogLevel.VERBOSE