Home > SYS_WebSocket > close

SYS_WebSocket.close() method

关闭 WebSocket 连接

Signature

close(id: string, code?: number, reason?: string, extensionUuid?: string): void;

Parameters

Parameter	Type	Description
id	string	自定义的 WebSocket ID
code	number	(Optional) 数字状态码，对应 WebSocket.CloseEvent 内允许的状态码
reason	string	(Optional) 一个人类可读的字符串，解释连接关闭的原因
extensionUuid	string	(Optional) 扩展 UUID，一般不需要指定，仅当需要操作其它扩展建立的 WebSocket 连接时才需要指定为其它扩展的 UUID

Returns

void

Remarks

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