来源于👉【知屋安砖】
接口调用类
初始化接口调用类
接口说明
初始化接口调用类
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
interfaceOptions | 入参 | object | 是 | {} |
interfaceOptions.devcode | 开发密钥 | string | 是 | {devcode: ‘devcode’} |
返回参数说明
名称 | 描述 | 类型 | 示例 |
---|---|---|---|
interface | 调用接口实例 | object | - |
使用示例
var interfaceOptions = { devcode: 'devcode' };
var interface = new Xhz.Interface(interfaceOptions);
使用get方法请求数据
接口说明
使用get方法请求数据
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
pathname | 请求路径 | string | 是 | ‘/pathname?k=door’ |
callback | 回调函数。回调函数中可以接收参数,data-返回数据,status-接口返回状态,fetchTarget-请求详细信息 | function | 是 | function(data, status, fetchTarget) {} |
使用示例
interface.get('/pathname?k=door', function(data, status, fetchTarget) {});
提示消息类
获取提示消息对象
接口说明
获取提示消息对象
返回参数说明
名称 | 描述 | 类型 | 示例 |
---|---|---|---|
Msg | 提示消息对象 | object | - |
使用示例
var Msg = Xhz.Msg;
普通提示消息
接口说明
普通提示消息
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
msg | 消息内容 | string | 否 | ‘提示消息’ |
callback | 回调函数。当提示消息关闭时触发。 | function | 否 | function() {} |
delay | 提示消息弹窗存在时间,若设置为 -1,则不自动关闭。默认是 3 秒后关闭 | number | 否 | -1 |
返回参数说明
名称 | 描述 | 类型 | 示例 |
---|---|---|---|
id | 提示消息的id | string | ‘100001’ |
使用示例
var id = Msg.info('消息提示');
警告提示消息
接口说明
警告提示消息
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
msg | 消息内容 | string | 否 | ‘提示消息’ |
callback | 回调函数。当提示消息关闭时触发。 | function | 否 | function() {} |
delay | 提示消息弹窗存在时间,若设置为 -1,则不自动关闭。默认是 3 秒后关闭 | number | -1 | - |
返回参数说明
名称 | 描述 | 类型 | 示例 |
---|---|---|---|
id | 提示消息的id | string | ‘100001’ |
使用示例
var id = Msg.warning('消息提示');
错误提示消息
接口说明
错误提示消息
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
msg | 消息内容 | string | 否 | ‘提示消息’ |
callback | 回调函数。当提示消息关闭时触发。 | function | 否 | function() {} |
delay | 提示消息弹窗存在时间,若设置为 -1,则不自动关闭。默认是 3 秒后关闭 | number | 否 | -1 |
返回参数说明
名称 | 描述 | 类型 | 示例 |
---|---|---|---|
id | 提示消息的id | string | ‘100001’ |
使用示例
var id = Msg.error('消息提示');
成功提示消息
接口说明
成功提示消息
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
msg | 消息内容 | string | 否 | ‘提示消息’ |
callback | 回调函数。当提示消息关闭时触发。 | function | 否 | function() {} |
delay | 提示消息弹窗存在时间,若设置为 -1,则不自动关闭。默认是 3 秒后关闭 | number | 否 | -1 |
返回参数说明
名称 | 描述 | 类型 | 示例 |
---|---|---|---|
id | 提示消息的id | string | ‘100001’ |
使用示例
var id = Msg.success('消息提示');
提示消息
接口说明
提示消息
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
msgConfig | 入参 | object | 是 | {} |
msgConfig.type | 消息提示类型。‘info’、‘success’、‘warning’、‘esuccess’ | string | 是 | {type: ‘info’} |
msgConfig.msg | 消息内容 | string | 否 | {msg: ‘提示消息’} |
msgConfig.callback | 回调函数。当提示消息关闭时触发 | function | 否 | {delay: function() {}} |
msgConfig.delay | 提示消息弹窗存在时间,若设置为 -1,则不自动关闭。默认是 3 秒后关闭 | number | 否 | {delay: -1} |
返回参数说明
名称 | 描述 | 类型 | 示例 |
---|---|---|---|
id | 提示消息的id | string | ‘100001’ |
使用示例
var id = Msg.on({type: 'error', msg: '错误消息提示'});
相关示例
消息提示框
更新提示消息内容
接口说明
更新提示消息内容
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
id | 提示消息id | string | 是 | ‘10001’ |
msg | 消息内容 | string | 是 | ‘普通消息提示’ |
使用示例
Msg.rendertTxt(id, '普通消息提示');
关闭提示消息
接口说明
关闭提示消息
传入参数说明
名称 | 描述 | 类型 | 必填 | 示例 |
---|---|---|---|---|
id | 提示消息id | string | 是 | ‘10001’ |
使用示例
Msg.close('10001');