mcm

概述

使用APICloud数据云服务时，客户端需要使用mcm模块来对云端数据进行操作，mcm模块包含了model、user、relation和query等对象

• model对象
• query对象
• relation对象
• user对象

config insert deleteById updateById findById findAll count exist uploadFile downloadFile

概述

通过model对象，可以对云端指定表内数据进行修改，以及通过查询条件进行查询。注：如果不是在云端编译的应用中测试，则需要调用config方法，配置appKey等信息

config

全局函数，配置appKey等应用信息。设置一次即生效，直到下一次设置，不设置默认为当前应用的信息

config({param})

params

appId：

• 类型：字符串
• 默认值：widget目录下config.xml里面的id
• 描述：应用的id，在APICloud上应用概览里获取，可以为空

appKey：

• 类型：字符串
• 默认值：无
• 描述：应用的安全校验Key，在APICloud上应用概览里获取，不能为空

host：

• 类型：字符串
• 默认值：无
• 描述：应用服务器地址，可为空，为空时默认为编译时的服务器地址

示例代码

var model = api.require('model');
model.config({
    appKey: 'A991A337-0212-A29D-0C9C-A518E39FXXXX',
    host: 'https://d.apicloud.com'
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

insert

向对象插入一条数据

insert({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

value：

• 类型：JSON 对象
• 默认值：无
• 描述：插入的键值对，与服务器上class中键值对应，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：插入成功后对应的该条数据在服务器的所有键值

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.insert({
    class: 'user',
    value: {
         name : 'text'
    }
}, function(ret, err){
    if( ret ){
         alert( JSON.stringify( ret ) );
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteById

根据ID删除对象的一条数据

deleteById({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

id：

• 类型：字符串
• 默认值：无
• 描述：被删除数据的行ID，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.deleteById({
    class: 'user',
    id: 'A0000000001'
}, function(ret, err){
    if( ret ){
         alert( JSON.stringify( ret ) );
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

updateById

根据ID更新对象的一条数据

updateById({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

id：

• 类型：字符串
• 默认值：无
• 描述：将要更新数据的行ID，不能为空

value：

• 类型：JSON
• 默认值：无
• 描述：将要更新的键值对，与服务器上class中键值对应，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：更新成功后对应的该条数据在服务器的所有键值

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.updateById({
    class: 'user',
    id: 'A000001',
    value: {
        nickname: 'Tom'
    }
}, function(ret, err){
    if( ret ){
         alert( JSON.stringify( ret ) );   
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

findById

根据ID查找对象的一条数据

findById({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

id：

• 类型：字符串
• 默认值：无
• 描述：被查找数据的行ID，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：查找成功后对应的该条数据在服务器的所有键值

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.findById({
    class: 'user',
    id: 'A00001'
}, function(ret, err){
    if( ret ){
         alert( JSON.stringify( ret ) );   
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

findAll

根据条件查找对象中所有符合条件的数据

findAll({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

qid：

• 类型：字符串
• 默认值：无
• 描述：通过query对象创建的查询条件对象ID，见query对象，不能为空

callback(ret, err)

ret：

• 类型：JSON数组
• 描述：查找成功后对应的所有满足条件的数据

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.findAll({
    class: "activity",
    qid: queryId
}, function( ret, err ) {
    if( ret ){
         alert( JSON.stringify( ret ) );   
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

count

根据条件返回对象下满足该条件的总记录数

count({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

qid：

• 类型：字符串
• 默认值：无
• 描述：通过query对象创建的查询条件对象ID，见query对象，可以为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.count({
    class: "user",
    qid: queryId
}, function( ret, err ) {
    if( ret ){
         alert( JSON.stringify( ret ) );   
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

exist

查询某对象下某行是否存在

exist({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

id：

• 类型：字符串
• 默认值：无
• 描述：被查找数据的行ID，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.exist({
    class: "book",
    id: "xxx"
}, function( ret, err ) {
    if( ret ){
         alert( JSON.stringify( ret ) );   
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

uploadFile

上传文件到云端file表里面

uploadFile({params}, callback(ret, err))

params

data：

• 类型：JSON 对象
• 默认值：无
• 描述：提交的文件及相关数据，不能为空
• 内部字段：

{
    file:            //文件对象，不能为空
    {
        url:''        //文件路径，不能为空
        name:''        //文件名
    },
    values:            //其它字段
    {
    }
};

report：

• 类型：布尔
• 默认值：false
• 描述：上传过程是否回调上传进度

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息，依赖于report字段，report为false时为上传完成时，服务器返回的数据

report为true时内部字段：
{
    progress:            //上传进度，0.00-100.00
    state:                //上传状态，（0-上传中 1-上传成功 2-上传失败）
    body:                //上传完成时，服务器返回的数据
}

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.uploadFile({
    report: false,
    data: {
        file: {
            name: 'apicloud.png',
            url: 'widget://res/img/apicloud.png'
        },
        values: {
            key1: 'value1',
            key2: 'value2'
        }
    }
}, function(ret, err){
    if( ret ){
         alert( JSON.stringify( ret ) );   
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

downloadFile

下载文件

downloadFile({params}, callback(ret, err))

params

url：

• 类型：字符串
• 默认值：无
• 描述：文件远程地址，url和id必须传一个

id：

• 类型：字符串
• 默认值：无
• 描述：已上传文件在云端file表中的行ID，url和id必须传一个

savePath：

• 类型：字符串
• 默认值：无
• 描述：存储路径，为空时使用自动创建的路径

report：

• 类型：布尔
• 默认值：false
• 描述：下载过程是否回调下载进度

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：下载信息
• 内部字段：

{
    fileSize:            //文件大小
    progress:            //下载进度，0.00-100.00
    state:                //下载状态，（0-下载中 1-下载成功 2-下载失败）
    savePath:            //文件的本地保存路径
}

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var model = api.require('model');
model.downloadFile({
    report: true,
    id: 'asfdasfasfasfasf',
    savePath: ''
}, function(ret, err) {
    if( ret ){
         alert( JSON.stringify( ret ) );   
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

createQuery limit skip asc desc include whereEqual whereNotEqual whereLike whereUnLike whereStartWith whereEndWith whereExist whereNotExist whereContain whereContainAll whereNotContain whereGreaterThan whereGreaterThanOrEqual whereLessThan whereLessThanOrEqual justFields exceptFields

概述

query对象用于构建一个或多个查询条件，包含分页、排序、以及其它where语句等，设置查询条件后，传递给model对象的查询方法，以获取符合条件的记录。

createQuery

创建一个query对象

createQuery(callback(ret, err))

callback(ret, err)

ret：

• 类型：JSON 对象

字段：

{
    qid：        //query对象的句柄ID，数字型
}

示例代码

var query = api.require('query');
query.createQuery(function( ret, err ){
    if( ret ){
         alert( JSON.stringify( ret ) );   
    }else{
         alert( JSON.stringify( err ) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

limit

设置查询返回结果限制为n条，相当于“分页”大小。

limit({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

value：

• 类型：数字
• 默认值：20
• 描述：被限制的数目值

示例代码

var query = api.require('query');
query.limit({
    qid: queryId, 
    value: 3
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

skip

设置查询返回结果中忽略前n条

skip({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

value：

• 类型：数字
• 默认值：0
• 描述：被忽略的数目值

示例代码

var query = api.require('query');
query.skip({
    qid: queryId, 
    value: 0
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

asc

设置查询返回结果按某列正序排列

asc({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：用于排序的列，不能为空

示例代码

var query = api.require('query');
query.asc({
    qid: queryId, 
    column: 'id'
});

补充说明

与desc互斥

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

desc

设置查询返回结果按某列倒序排列

desc({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：用于排序的列，不能为空

示例代码

var query = api.require('query');
query.desc({
    qid: queryId, 
    column: 'id'
});

补充说明

与asc互斥

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

include

设置查询返回结果中包含pointer指向的对象

include({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：pointer列名，不能为空

示例代码

var query = api.require('query');
query.include({
    qid: queryId,
    column: 'column'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereEqual

设置查询条件为某列等于某值

whereEqual({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，不能为空

示例代码

var query = api.require('query');
query.whereEqual({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个，与whereNotEqual互斥

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereNotEqual

设置查询条件为某列不等于某值

whereNotEqual({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，不能为空

示例代码

var query = api.require('query');
query.whereNotEqual({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个，与whereEqual互斥

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereLike

设置查询条件为某列内容中包含某值

whereLike({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，不能为空

示例代码

var query = api.require('query');
query.whereLike({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereUnLike

设置查询条件为某列内容中不包含某值

whereUnLike({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，不能为空

示例代码

var query = api.require('query');
query.whereUnLike({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereStartWith

设置查询条件为某列内容以某值开头

whereStartWith({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，不能为空

示例代码

var query = api.require('query');
query.whereStartWith({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereEndWith

设置查询条件为某列内容以某值结尾

whereEndWith({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，不能为空

示例代码

var query = api.require('query');
query.whereEndWith({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereExist

设置查询条件为某列内容不为空

whereExist({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

示例代码

var query = api.require('query');
query.whereExist({
    qid: queryId,
    column: 'id'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereNotExist

设置查询条件为某列内容为空

whereNotExist({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

示例代码

var query = api.require('query');
query.whereNotExist({
    qid: queryId,
    column: 'id'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereContain

设置查询条件为某列内容中包含某值

whereContain({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，不能为空

示例代码

var query = api.require('query');
query.whereContain({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个，该列需为array型

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereContainAll

设置查询条件为某列内容中包含某几个值

whereContainAll({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串数组
• 默认值：无
• 描述：作为条件的多个值，不能为空

示例代码

var query = api.require('query');
query.whereContainAll({
    qid: queryId,
    column: 'id',
    value: ['A00000000001']
});

补充说明

可设置多个，该列需为array型

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereNotContain

设置查询条件为某列内容中不包含某值

whereNotContain({params})

arams

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，不能为空

示例代码

var query = api.require('query');
query.whereNotContain({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个，该列需为array型

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereGreaterThan

设置查询条件为某列的内容大于某值

whereGreaterThan({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，数字或者date型，不能为空

示例代码

var query = api.require('query');
query.whereGreaterThan({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereGreaterThanOrEqual

设置查询条件为某列的内容大于等于某值

whereGreaterThanOrEqual({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，数字或者date型，不能为空

示例代码

var query = api.require('query');
query.whereGreaterThanOrEqual({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereLessThan

设置查询条件为某列的内容小于某值

whereLessThan({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，数字或者date型，不能为空

示例代码

var query = api.require('query');
query.whereLessThan({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

whereLessThanOrEqual

设置查询条件为某列的内容小于等于某值

whereLessThanOrEqual({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：作为条件的列名，不能为空

value：

• 类型：字符串
• 默认值：无
• 描述：作为条件的值，数字或者date型，不能为空

示例代码

var query = api.require('query');
query.whereLessThanOrEqual({
    qid: queryId,
    column: 'id',
    value: 'A00000000001'
});

补充说明

可设置多个

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

justFields

设置查询仅返回需要的字段

justFields({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

value：

• 类型：字符串数组
• 默认值：无
• 描述：字段的值，不能为空

示例代码

var query = api.require('query');
query.justFields({
    qid: queryId,
    value: ['value']
});

补充说明

与exceptFields互斥

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

exceptFields

设置查询返回除某些字段以外的字段

exceptFields({params})

params

qid：

• 类型：数字
• 默认值：无
• 描述：query对象句柄ID，由createQuery创建而来，不能为空

value：

• 类型：字符串数组
• 默认值：无
• 描述：字段的值，不能为空

示例代码

var query = api.require('query');
query.exceptFields({
    qid: queryId,
    value: ['value']
});

补充说明

与justFields互斥

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

insert count findAll deleteAll

概述

relation对象主要用于对一张表中数据类型为Relation的列进行操作

insert

向对象的某关系列下插入一条内容

insert({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

id：

• 类型：字符串
• 默认值：无
• 描述：被插入对象ID，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：关系列的名称，对应服务器上的同名relation，不能为空

value：

• 类型：JSON 对象
• 默认值：无
• 描述：插入的键值对，与服务器上class中键值对应，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var relation = api.require('relation');
relation.insert({
    class: 'user',
    id: 'A00001',
    column: 'column',
    value: {
        name: 'value'
    }
}, function(ret, err){
     if( ret ){
        alert( JSON.stringify( ret) );
     }else{
        alert( JSON.stringify( err) );
     }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

count

查找对象某关系列下对应的数据总条数

count({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

id：

• 类型：字符串
• 默认值：无
• 描述：被查找对象ID，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：关系列的名称，对应服务器上的同名relation，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var relation = api.require('relation');
relation.count({
    class: 'user',
    id: 'A00001',
    column: 'column'
}, function(ret, err){
     if( ret ){
        alert( JSON.stringify( ret) );
     }else{
        alert( JSON.stringify( err) );
     }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

findAll

查找对象某关系列下对应的所有数据

findAll({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

id：

• 类型：字符串
• 默认值：无
• 描述：被查找对象ID，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：关系列的名称，对应服务器上的同名relation，不能为空

callback(ret, err)

ret：

• 类型：JSON数组
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var relation = api.require('relation');
relation.findAll({
    class: 'user',
    id: 'A000000001',
    column: 'column'
}, function (ret, err) {
    if( ret ){
        alert( JSON.stringify( ret) );
    }else{
        alert( JSON.stringify( err) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteAll

删除对象某关系列下对应的所有数据

deleteAll({params}, callback(ret, err))

params

class：

• 类型：字符串
• 默认值：无
• 描述：对象的名称，对应服务器上的同名class，不能为空

id：

• 类型：字符串
• 默认值：无
• 描述：被删除对象ID，不能为空

column：

• 类型：字符串
• 默认值：无
• 描述：关系列的名称，对应服务器上的同名relation，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var relation = api.require('relation');
relation.deleteAll({
    class: 'user',
    id: 'A00001',
    column: 'column'
}, function(ret, err){
     if( ret ){
        alert( JSON.stringify( ret) );
     }else{
        alert( JSON.stringify( err) );
     }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

login register logout updatePassword

概述

user对象提供用户相关操作，包括注册、登录、修改密码等

login

登录

login({params}, callback(ret, err))

params

username：

• 类型：字符串
• 默认值：无
• 描述：用户名，不能为空

password：

• 类型：字符串
• 默认值：无
• 描述：密码，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var user = api.require('user');
user.login({
    username: 'name',
    password: '12345678'
}, function( ret, err ) {
     if( ret ){
        alert( JSON.stringify( ret) );
     }else{
        alert( JSON.stringify( err) );
     }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

register

注册

register({params}, callback(ret, err))

params

username：

类型：字符串 默认值：无 描述：用户名，不能为空

password：

类型：字符串 默认值：无 描述：密码，不能为空

email：

类型：字符串 默认值：无 描述：邮箱，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var user = api.require('user');
user.register({
    username: 'uname',
    password: '111111',
    email: 'xixi@apicloud.com'
}, function( ret, err ) {
    if( ret ){
        alert( JSON.stringify( ret) );
    }else{
        alert( JSON.stringify( err) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

logout

注销登录

logout(callback(ret, err))

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var user = api.require('user');
user.logout(function(ret, err){
    if( ret ){
        alert( JSON.stringify( ret) );
    }else{
        alert( JSON.stringify( err) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

updatePassword

修改密码

updatePassword({params}, callback(ret, err))

params

password：

• 类型：字符串
• 默认值：无
• 描述：密码，不能为空

callback(ret, err)

ret：

• 类型：JSON 对象
• 描述：成功信息

err：

• 类型：JSON 对象
• 描述：错误信息

示例代码

var user = api.require('user');
user.updatePassword({
    password: 'newPwd'
}, function(ret, err) {
    if( ret ){
        alert( JSON.stringify( ret) );
    }else{
        alert( JSON.stringify( err) );
    }
});

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本