# Interface: CloseSocketParams ‹Err›
• CloseSocketParams‹Err›()
# Type parameters:
▪ Err: MogsRes
# Type parameters
▪ Err: MogsRes
# Properties
# Optional
code
• code? : number
一个数字值表示关闭连接的状态号,表示连接被关闭的原因。
default
1000 - 表示正常关闭连接
Returns: number
# Optional
reason
• reason? : string
一个可读的字符串,表示连接被关闭的原因。 这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。
Returns: string
# Methods
# Optional
complete
▸ complete(res
: CloseSocketRes | Err): void
Inherited from MogsParams.complete
接口调用结束的回调函数(调用成功、失败都会执行)
# 参数:
属性 | 类型 |
---|---|
res | CloseSocketRes | Err |
# 返回值:
void
# Optional
fail
▸ fail(err
: Err): void
Inherited from MogsParams.fail
接口调用失败的回调函数
# 参数:
属性 | 类型 |
---|---|
err | Err |
# 返回值:
void
# Optional
success
▸ success(res
: CloseSocketRes): void
Inherited from MogsParams.success
接口调用成功的回调函数
# 参数:
属性 | 类型 |
---|---|
res | CloseSocketRes |
CloseSocketRes
属性 | 类型 | 描述 |
---|---|---|
errMsg | string | API 调用成功/失败的消息 |
# 返回值:
void