555-ntm-sdk 中文文档教程

Question

555 NTM SDK

Overview

555 Ntm SDK 提供订阅通知、注销订阅者和删除订阅通知的 api。

Feature list

SDK provides apis for

1）为特定的通知主题和协议注册订阅者 2）注销订户 3) 删除订阅的通知 4) 设置 sdk 的日志级别

Usage

客户端可以使用这个模块来完成整体通知相关的任务。

setConfig API

使用 setConfig API 设置初始通知配置。

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

Parameters

以下是需要填充的配置对象成员：

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

createSubscriptions API

使用 createSubscriptions API 为订阅者创建特定主题和协议的订阅。

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

Parameters

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

以下是需要填充的订阅对象：

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 返回一个承诺。
如果调用成功。对于创建的每个唯一订阅者 ID，响应将有一个对象数组，其中包含订阅者 ID、协议和主题数组。
否则错误 JSON 代码和错误原因。

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

deleteSubscription API

使用 deleteSubscription API 删除特定订阅者订阅。

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 返回承诺。
如果调用成功，将返回具有已删除订阅的 topic 和 subscriberId 的对象作为响应
否则错误 JSON 代码和错误原因。

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

使用 deleteAllSubscriptions API 取消注册订阅者。

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

Parameters

Property	Type	Description
subscriberId	string	subscriber id

Handling Response

deleteAllSubscriptions API 返回承诺。
如果调用成功，删除的 subscriberId 将作为响应返回
否则错误 JSON 代码和错误原因。

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

使用 setLogLevel API 设置 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

以下是 Rtc555NTM.LogLevel 值

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