Home > SYS_WebSocket > register

SYS_WebSocket.register() method

注册 WebSocket 连接

签名

register(id: string, serviceUri: string, receiveMessageCallFn?: (event: MessageEvent<any>) => void | Promise<void>, connectedCallFn?: () => void | Promise<void>, protocols?: string | Array<string>): void;

参数名

参数	类型	描述
id	string	自定义 WebSocket ID
serviceUri	string	WebSocket 服务地址
receiveMessageCallFn	(event: MessageEvent<any>) => void | Promise<void>	(Optional) 接收到消息时的回调函数
connectedCallFn	() => void | Promise<void>	(Optional) 连接建立时的回调函数
protocols	string | Array<string>	(Optional) 子协议

返回值

void

备注

可以用来执行前检测 WebSocket 连接是否正常，但需要注意 **不要尝试相同 ID 不同参数的连接**，这会造成混乱： 如果存在指定 ID 且处于活跃状态中的 WebSocket 连接，那么其余参数的变更将不会被应用

注意：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 throw Error