# Interface: GetSettingParams ‹Err›
• GetSettingParams‹Err›()
# Type parameters:
▪ Err: MogsRes
# Type parameters
▪ Err: MogsRes
# Properties
# Optional
withSubscriptions
• withSubscriptions? : boolean
是否同时获取用户订阅消息的订阅状态
description
注意:withSubscriptions 只返回用户勾选过订阅面板中的"总是保持以上选择,不再询问"的订阅消息。
default
false
Returns: boolean
# Methods
# Optional
complete
▸ complete(res
: GetSettingRes | Err): void
Inherited from MogsParams.complete
接口调用结束的回调函数(调用成功、失败都会执行)
# 参数:
属性 | 类型 |
---|---|
res | GetSettingRes | Err |
# 返回值:
void
# Optional
fail
▸ fail(err
: Err): void
Inherited from MogsParams.fail
接口调用失败的回调函数
# 参数:
属性 | 类型 |
---|---|
err | Err |
# 返回值:
void
# Optional
success
▸ success(res
: GetSettingRes): void
Inherited from MogsParams.success
接口调用成功的回调函数
# 参数:
属性 | 类型 |
---|---|
res | GetSettingRes |
GetSettingRes
属性 | 类型 | 描述 |
---|---|---|
authSetting | AuthSetting | 用户授权结果 |
errMsg | string | API 调用成功/失败的消息 |
subscriptionsSetting? | SubscriptionsSetting | 用户订阅消息设置 |
# 返回值:
void