系统设置接口

1 接口描述

此接口用于跳转到系统设置界面或者查询当前客户端设置状态,比如查看GPS、推送通知是否打开等。

2 调用命令

2.1 命令格式

该接口有两种调用方式,如下所示:

(1) 跳转到系统设置界面

http://CMBLS/SystemSetting?action=Jump&id=XXX&type=YYY&hideAlert=True/False

(2) 跳转到系统设置界面

http://CMBLS/SystemSetting?action=QueryStatus&id=XXX&type=YYY


2.2 字段定义

字段
含义
id

功能标识。

action

操作类型。可能的取值:

jump: 跳转到设置界面;

querystatus: 查询系统设置状态。

type

系统设置类型。可能的取值:

MSGPush: 消息推送;

GPS: 定位服务;

wifiInfo: WI-fi列表信息(仅Android支持);

NFC: 近场通信,iphone不支持NFC;

Camera: 摄像头权限;

Bluetooth: 蓝牙权限(6.1.0版本以上支持)
Microphone: 音频权限 ;

AppSetting: APP系统设置,action取值为jump时有效;

OSSetting: 操作系统设置,action取值为jump时有效。

hidealert

是否弹出提示框。取值true/false。Action取值为jump时有效。 没有此参数或者参数值为False则显示Alert。其他情况不显示Alert直接跳转。


3 回调函数

3.1 成功回调函数

CMBLS.SystemSetting.successCallback(id,message)

其中,id与调用命令中id字段相同,message的值为

<Result>
<StateCode>0</StateCode>
<Description>Success</Description>
<Action>XXX</Action>
<data>
<status></status>//跳转设置成功“Y”;查询设置(GPS、通知等)开关打开为“Y”,关闭为“N”。
</data>
</Result>

备注:如果action=QueryStatus,type=wifiInfo时data中返回数据为:
<data>
  <status>Y/N</status>//Y: 手机wifi已打开; N:手机wifi未打开
  <wifiList>
   <item>
     <SSID> XXX</SSID>
     <BSSID>XXX</BSSID>
   </tem>
   <item>
     <SSID> XXX</SSID>
     <BSSID>XXX</BSSID>
   </tem>
     ….
  </wifiList>
</data>



3.2 失败回调函数

CMBLS.SystemSetting.failCallback(id,message)

其中,id与调用命令id字段相同,message值为

<Result>
<StateCode>非0的错误码</StateCode>
<Action>XXX</Action>
<Description>错误信息</Description>
</Result>


4 调用示例

http://CMBLS/SystemSetting?action=QueryStatus&id=123&type=wifiInfo

5 备注