@555platform/555-connection 中文文档教程

Question

555-connection

555 JavaScript SDK for connection

555-connection 提供简单的 API 来与 555 平台建立连接。

Getting started

  npm i @555platform/555-connection

Usage - Examples

import SDK from '@555platform/555-connection';

1. 使用 555token、ConnectOptions 和 MessageAdapter

   const sdk = SDK.Client.create(
               userData.access_token,
               {
             url: '',
             automaticReconnect: true
               },
               new SDK.QueuedMessageAdapter<SDK.MessagePayload>()
           );
   
   
   sdk.connect();
   

2. 回调

   javascript 建立连接 sdk.onTokenAboutToExpire(() =>; // renewToken 是你需要实现的函数来获取新的令牌 // 来自应用服务器 renewToken(renewedToken => sdk.updateToken(renewedToken)); );

APIs

Connect

Methods

<static> create(accessToken, ConnectOptions, messageAdapter)

创建和初始化客户端的工厂方法

Parameters

Name	Type	Argument	Description
accessToken	string	required	555 Platform access token
options	ConnectOptions	required	Options to customize 555 Connection behavior
messageAdapter	MessageAdapter	required	Message adapter class conforming to MessageAdapter interface

Returns

Type

Client|Error

updateToken(accessToken)

更新当前令牌。 用于使用刷新的令牌更新客户端。

参数

Name	Type	Argument	Description
accessToken	string	required	555 Platform access token

返回

类型

void

connect()

连接到平台。

参数

Name	Type	Argument	Description
options	ConnectOptions	optional	Connection options

返回

类型

Promise.

disconnect()

手动断开客户端。

返回

类型

Promise.

AccessTokenAboutToExpire

在访问令牌到期前 5 分钟触发。

client.onTokenAboutToExpire(() =>
  // renewToken is a function you need to implement to fetch new token
  // from application server
  renewToken(renewedToken => sdk.updateToken(renewedToken));
);

Options

ConnectOptions

这些选项是连接平台的参数。

类型

对象

属性

Name	Type	Argument
url	string	required
protocol	string[]	optional
automaticReconnect	boolean	optional
reconnectionAttempts	number	optional
reconnectDelay	number	optional
reconnectBackoffAlgorithm	BackoffAlgorithm	optional
pollInterval	number	optional
requestTimeout	number	optional
requestRetries	number	optional
paginatorDefaultPageSize	number	optional
nextPingDelay	number	optional
pingWaitDelay	number	optional