JS SDK #

  • 适用于网页端,H5页面,前端页面
  • HTML页引用
<script src="...路径/upush2-web-client.js"></script>
<script>
// 调用方法 
// upush.UPush.方法
// 设置监听
// var upushlistener = new upush.UPushListener();
// upushlistener.setXXX 
</script>
  • es6引用
import { UPush, UPushListener } from 'upush2-web-client'

UPush #

/**
 * 配置
 * @param {String} packageName     包名
 * @param {String} appId           项目唯一标示
 * @param {String} appKey          应用唯一标示
 * @param {UPushListener} listener 时间监听
 */
configUPush(packageName, appId, appKey, listener)

/**
 * 注册推送
 * @param {String}  wsUrl websocket地址
 * @returns 
 */
registerUPush(wsUrl)

/**
 * 注册到指定连接服务
 * @param {String} wsUrl websocket地址
 */
registerSpecifiedUPushServer(wsUrl)

/**
 * 注销
 */
unregisterUPush()

/**
 * 绑定用户
 * @param {String} userId 用户唯一标示
 */
bindUser(userId)

/**
 * 取得绑定的userId
 */
getUserId()

/**
 * 取得状态
 */
getStatus()

/**
 * 获得PushToken
 */
getPushToken()

UPushListener #

详细参照

/**
 * pushToken监听
 * @event {Function(code: Number, pushToken: String, serverTime: Number, userId: String)} cb 
 */
setOnPushToken(cb)

/**
 * 接收消息
 * @event {Function(msg: UMessage, timestamp: Date, isOfflineMsg: Boolean)} cb   支持async
 */
setOnPush(cb)
  
/**
 * 注销完成监听
 * @event {Function()} cb 
 */
setOnUnregister(cb)

/**
 * 消息撤回
 * @event {Function({fromId, msgId, alert}} cb  支持async
 */
setOnRevoke(cb)

/**
 * 状态监听
 * @event {Function(status: Int)} cb 
 */
setOnStatus(cb)

/**
 * 绑定用户监听
 * @event {Function(status: Int)} cb 
 */
setOnBindUser(cb)

/**
 * 用户在其他设备注册,被顶掉
 * @event {Function({ip, platform})} cb 
 */
setOnRegisteredOnAnotherDevice(cb)


其他 #

状态码
错误码
UMessage参照

上次更新: 4/16/2024, 6:08:51 PM