mobUms

来自于：开发者

init showProfilePage showRecommendationPage loginWithPhoneNumber loginWithSocialAccount sendVerifyCodeForRegitser sendVerifyCodeForResetPassword registerWithPhoneNumber resetPasswordWithPhoneNumber updateUserInfo uploadAvatar changePassword logout bindPhone bindSocialAccount getLoginUserToken getLoginUserId isBindPhone getLoginUser followUser stopFollow deleteFans isMyFollowing isMyFans getFieldUser getFollowingsId getFansId getVerificationCode submitVerificationCode

概述

简介

本模块封装了 mob.com 的 UMSSDK ，用于零成本搭建APP用户系统，使得开发者开发一个APP快速拥有一个用户系统，极大的降低开发成本。

主要功能

• 提供注册、登录、个人资料等一站式解决方案
• 支持 手机号、微信、QQ、新浪微博、FaceBook
• 自定义用户资料字段
• 后台用户管理，查看用户新增、登录、设备日活、停留时长等数据
• 集成 GUI 界面，简单快速实现用户系统
• 好友关系，添加删除好友、关注、互粉、黑名单等好友关系功能，部分功能需要在 GUI 中实现
• 可单独使用短信验证码及验证功能
• 集成 ShareSDK3.0.0（用于第三方登录） 和 SMSSDK3.0.0（用于发送验证码）

模块使用攻略

• 使用本模块需要到 http://www.mob.com 申请 shareSDK 模块的开发者账号，并创建应用获取到 shareSDK 的 Appkey。申请教程参考mob论坛技术贴。

• 模块技术贴 及测试用例下载

• 配置自定义 Info.plist 文件

在 iOS 平台上（android平台忽略此步骤）需要把从 mob 申请到的 appKey 和 secret 配置到 Info.plist 文件内。Info.plist 配置方法参考 iOS 修改 Info.plist 。 配置示例：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>MOBAppKey</key>
    <string>22440ddd3eabd</string><!-- Mob的AppKey -->
    <key>MOBAppSecret</key>
    <string>288535ff9c8a06f23c0d04189c2e601c</string><!-- Mob的AppSecret -->
    <key>CFBundleURLTypes</key>
    <array>
        <dict>
            <key>CFBundleTypeRole</key>
            <string>Editor</string>
            <key>CFBundleURLSchemes</key>
            <array>
                <string>wxb05fd5b436d00743</string><!-- 第三方 urlScheme -->
                <string>QQ05FB8B52</string><!-- 第三方 urlScheme -->
                <string>tencent100371282</string><!-- 第三方 urlScheme -->
                <string>fb1201984966578499</string><!-- 第三方 urlScheme -->
                <string>wb568898243</string><!-- 第三方 urlScheme -->
            </array>
        </dict>
    </array>
</dict>
</plist>

字段描述:

1. 以上带有注释的字段才需要修改，其他字段不要改动
2. MOBAppKey和MOBAppSecret必须配置
3. urlScheme如果有支持的第三方就需要配置
4. urlScheme说明:用于实现应用间跳转及数据交换，本应用可以启动第三方平台客户端，也可以从第三方平台客户端跳回本应用。urlScheme 的 value 值是从第三方分享平台获取。若同时支持多个平台，则要配置多个 urlScheme。以下是各个平台配置规范：
5. QQ：要填两个URL scheme: 一个是tencent + appId ; 一个是 QQ + appId 转换成的十六进制（如果appId转换的16进制数不够8位则在前面补0，如转换的是：5FB8B52，则最终填入为：QQ05FB8B52 注意：转换后的字母要大写），这里的 QQ 一定要是大写 微信：是从微信开放平台获取的 appid，如：wxd0d84bbf23b4a0e4 新浪微博：从新浪微博开放平台获取到的 App Key 拼接前缀 wb 而成的，如：wb1132217156 Facebook：设置格式为fb+AppID

SDK不完善需要避开的地方

• 使用无GUI函数的不要用官方提供的 country,province,city 字段，要实现该数据请自定义字段用自己的算法，使用GUI的除外
• 如果用第三方注册，再绑定手机号，这样就不能更改手机登录的密码了，提示错误编号501
• 如果用第三方注册，再绑定手机号，getFieldUser 通过手机号查找是找不到的
• getFieldUser 不能使用自定义字段查找
• IOS大部分函数只支持苹果5s及以上机型
• IOS返回的很多是英文信息，已翻译常用的，IOS版GUI上的英文如星座无法翻译
• isMyFollowing 和 isMyFans 函数在IOS中无关系的无回掉信息

模块接口

init

初始化

init({params})

params

appkey：

• 类型：字符串
• 描述：从 mob 平台申请的 AppKey

appsecret：

• 类型：字符串
• 描述：从 mob 平台申请的 AppSecret

platform：

• 类型：数组
• 描述：各社交平台key，目前支持 微信、QQ、新浪微博、FaceBook，如果不打算支持某第三方平台可忽略数组中的一组值

• 内部字段：

  [{
    name:"Wechat",            //固定值,注意大小写
    AppId:"xxx",            //AppId
    AppSecret:"xxx"            //AppSecret
  },{
    name:"QQ",                //固定值,注意大小写
    AppId:"xxx",            //AppId
    AppKey:"xxx"            //AppKey
  },{
    name:"SinaWeibo",        //固定值,注意大小写
    AppKey:"xxx",            //AppKey
    AppSecret:"xxx",        //AppSecret
    RedirectUrl:"xxx"        //RedirectUrl
  },{
    name:"Facebook",        //固定值,注意大小写
    ConsumerKey:"xxx",        //ConsumerKey
    ConsumerSecret:"xxx",    //ConsumerSecret
    RedirectUrl:"xxx"        //RedirectUrl
  }];

示例代码

    var mobUms = api.require("mobUms");
    mobUms.init({
        appkey:"22440ddd3eabd",
        appsecret:"288535ff9c8a06f23c0d04189c2e601c",
        platform:[{
            name:"Wechat",
            AppId:"wxb05fd5b436d00743",
            AppSecret:"4e656dc8724dd78ba81b8c2fdd844787"
        },{
            name:"QQ",
            AppId:"100371282",
            AppKey:"aed9b0303e3ed1e27bae87c33761161d"
        },{
            name:"SinaWeibo",
            AppKey:"568898243",
            AppSecret:"38a4f8204cc784f81f9f0daaf31e02e3",
            RedirectUrl:"http://www.sharesdk.cn"
        },{
            name:"Facebook",
            ConsumerKey:"1201984966578499",
            ConsumerSecret:"eb6e8dcb41cfc7223ffbdaf31fece024",
            RedirectUrl:"http://mob.com"
        }]
    });

可用性

iOS系统，Android系统
可提供的1.0.0及更高版本

showProfilePage

打开我的资料页面

showProfilePage()

示例代码

    var mobUms = api.require("mobUms");
    mobUms.showProfilePage();
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showRecommendationPage

打开最近登录列表页

showRecommendationPage()

示例代码

    var mobUms = api.require("mobUms");
    mobUms.showRecommendationPage();
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

loginWithPhoneNumber

以手机号码登录，需要先手机注册

loginWithPhoneNumber({params}, callback(ret))

params

country：

• 类型：字符串
• 描述：国家代码，如：中国对应86

phone：

• 类型：字符串
• 描述：手机号码

password：

• 类型：字符串
• 描述：密码

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,    //布尔型 true||false
    userId:"",        //用户id
    token:"",        //用户令牌token，每次登录都不一样
    msg:""            //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.loginWithPhoneNumber({
        country:"86",
        phone:"",
        password:""
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg+"\r\nuserId:"+ret.userId+"\r\ntoken:"+ret.token });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

loginWithSocialAccount

以社交账号码登录，没有登录过将建立新用户

loginWithSocialAccount({params}, callback(ret))

params

Social：

• 类型：字符串
• 描述：社交平台，支持四种
• 取值范围：
  • Wechat（微信）
  • QQ（QQ）
  • SinaWeibo（新浪微博）
  • Facebook（脸书）

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,    //布尔型 true||false
    userId:"",        //用户id
    token:"",        //用户令牌token，每次登录都不一样
    msg:""            //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.loginWithSocialAccount({
        Social:"QQ"},
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg+"\r\nuserId:"+ret.userId+"\r\ntoken:"+ret.token });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendVerifyCodeForRegitser

请求用于注册的短信验证码

sendVerifyCodeForRegitser({params}, callback(ret))

params

country：

• 类型：字符串
• 描述：国家代码，如：中国对应86

phone：

• 类型：字符串
• 描述：手机号码

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,    //布尔型 true||false
    inteVali:true,    //布尔型 是否智能验证（仅限android），作者建议还是不要在后台开启智能验证功能
    msg:""            //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.sendVerifyCodeForRegitser({
        country:"86",
        phone:phone
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: "执行成功\r\n智能验证:"+ret.inteVali });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendVerifyCodeForResetPassword

请求用于重置密码的短信验证码，注意不要和前面函数搞混了

sendVerifyCodeForResetPassword({params}, callback(ret))

params

country：

• 类型：字符串
• 描述：国家代码，如：中国对应86

phone：

• 类型：字符串
• 描述：手机号码

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,    //布尔型 true||false
    inteVali:true,    //布尔型 是否智能验证（仅限android），作者建议还是不要在后台开启智能验证功能
    msg:""            //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.sendVerifyCodeForResetPassword({
        country:"86",
        phone:phone
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: "执行成功\r\n智能验证:"+ret.inteVali });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

registerWithPhoneNumber

以电话号码执行注册，各字段限制请登录后在 管理控制台->UMSSDK->字段管理 中查看，如不写某个字段请忽略

registerWithPhoneNumber({params}, callback(ret))

params

country：

• 类型：字符串
• 描述：国家代码，如：中国对应86

phone：

• 类型：字符串
• 描述：手机号码

vcode：

• 类型：字符串
• 描述：手机验证码

password：

• 类型：字符串
• 描述：密码

nickname：

• 类型：字符串
• 描述：昵称

avatarId：

• 类型：字符串
• 描述：头像id，这个id是通过uploadAvatar函数返回的id

gender：

• 类型：字符串
• 描述：性别
• 取值范围：
  • 男
  • 女
  • 保密

birthday：

• 类型：字符串
• 描述：生日，字符串格式 “2000-01-10”

age：

• 类型：数字
• 描述：年龄

constellation：

• 类型：字符串
• 描述：星座
• 取值范围：星座的名称+”座”，如：”狮子座”

zodiac：

• 类型：字符串
• 描述：生肖
• 取值范围：生肖名，如：”牛”

signature：

• 类型：字符串
• 描述：签名

email：

• 类型：字符串
• 描述：电子邮箱

address：

• 类型：字符串
• 描述：地址

zipCode：

• 类型：数字
• 描述：邮政编码

resume：

• 类型：字符串
• 描述：简介

customize：

• 类型：JSON 对象
• 描述：自定义字段，目前支持两种数据类型，字符串和数字，其他数据类型因SDK支持不好，就没有集成，如果想保存其他数据类型请转换成字符串或数字。注意自定义字段不能通过 getFieldUser 函数查找，如果有自定义数据查找的需求可以用默认字段替代，然后再建立一个对应的自定义字段。默认字段就是个名字并不一定只能保存相应数据，保存其他数据也是可以的，只要数据类型是匹配的就行

• 内部字段：

  {
    //键值对形式
    csString:"测试数据",                //键写自定义字段的数据字段名
    csNumber:123,                    //数字型
    csDate:"2001-01-11 1:35:56"        //字符串来保存日期时间型
  }

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,    //布尔型 true||false
    userId:"",        //用户id
    token:"",        //用户令牌token，每次登录都不一样，注册成功后立即就登录了
    msg:""            //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.registerWithPhoneNumber({
        country:"86",
        phone:"1xxxxxxxxxx",
        vcode:"0000",
        password:"123",
        nickname:"王三",            //昵称
        avatarId:avatarId,            //头像id
        gender:"保密",                //性别
        birthday:"2000-01-10",        //生日
        age:1,                        //年龄
        constellation:"狮子座",        //星座
        zodiac:"牛",                //生肖
        signature:"我的签名",        //签名
        email:"123@qq.com",            //电子邮箱
        address:"北京",                //地址
        zipCode:100010,                //邮政编码
        resume:"简介",                //简介
        customize:{                    //自定义
            csString:"测试数据",
            csNumber:123,
            csDate:"2001-01-11"
        }
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg+"\r\nuserId:"+ret.userId+"\r\ntoken:"+ret.token });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

resetPasswordWithPhoneNumber

以电话号码执行重置密码，注意：如果用第三方平台注册，再绑定手机号，这样就不能更改手机登录的密码了

resetPasswordWithPhoneNumber({params}, callback(ret))

params

country：

• 类型：字符串
• 描述：国家代码，如：中国对应86

phone：

• 类型：字符串
• 描述：手机号码

vcode：

• 类型：字符串
• 描述：手机验证码

password：

• 类型：字符串
• 描述：密码

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,    //布尔型 true||false
    msg:""            //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.resetPasswordWithPhoneNumber({
        country:"86",
        phone:"1xxxxxxxxxx",
        vcode:"0000",
        password:"123"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

updateUserInfo

更新用户资料

updateUserInfo({params}, callback(ret))

params

nickname：

• 类型：字符串
• 描述：昵称

avatarId：

• 类型：字符串
• 描述：头像id，这个id是通过uploadAvatar函数返回的id

gender：

• 类型：字符串
• 描述：性别
• 取值范围：
  • 男
  • 女
  • 保密

birthday：

• 类型：字符串
• 描述：生日，字符串格式 “2000-01-10”

age：

• 类型：数字
• 描述：年龄

constellation：

• 类型：字符串
• 描述：星座
• 取值范围：星座的名称+”座”，如：”狮子座”

zodiac：

• 类型：字符串
• 描述：生肖
• 取值范围：生肖名，如：”牛”

signature：

• 类型：字符串
• 描述：签名

email：

• 类型：字符串
• 描述：电子邮箱

address：

• 类型：字符串
• 描述：地址

zipCode：

• 类型：数字
• 描述：邮政编码

resume：

• 类型：字符串
• 描述：简介

customize：

• 类型：JSON 对象
• 描述：自定义字段，目前支持两种数据类型，字符串和数字，其他数据类型因SDK支持不好，就没有集成，如果想保存其他数据类型请转换成字符串或数字。

• 内部字段：

  {
    //键值对形式
    csString:"测试数据",                //键写自定义字段的数据字段名
    csNumber:123,                    //数字型
    csDate:"2001-01-11 1:35:56"        //字符串来保存日期时间型
  }

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,    //布尔型 true||false
    msg:""            //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.updateUserInfo({
        nickname:"小红",            //昵称
        avatarId:avatarId,            //头像id
        gender:"保密",                //性别
        birthday:"1800-01-1",        //生日
        age:2,                        //年龄
        constellation:"水瓶座",        //星座
        zodiac:"狗",                //生肖
        signature:"我的钱钱",        //签名
        email:"789@qq.com",            //电子邮箱
        address:"东城",                //地址
        zipCode:100020,                //邮政编码
        resume:"简介1",                //简介
        customize:{                    //自定义
            csString:"测试数据",
            csNumber:1235455645446423,
            csDate:"2099-1-1 8:00:01"
        }
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

uploadAvatar

上传头像

uploadAvatar({params}, callback(ret))

params

path：

• 类型：字符串
• 描述：路径，绝对路径格式，如”fs://image/avatar.png”，好像这里不能使用widgett://协议，请各位开发者在实际中确认一下

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,        //布尔型 true||false
    id:"",                //头像id，此id不能长期保存，在获取后立即在registerWithPhoneNumber和updateUserInfo中使用
    avatar:["","",""],    //数组 头像上传后生成的大中小三种图的链接
    msg:""                //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.uploadAvatar({
        path:"fs://image/avatar.png"
        },
        function(ret) {
            if(ret.status) {
                avatarId = ret.id;
                api.alert({ msg: ret.msg+"\r\nid:"+ret.id+"\r\navatar:"+ret.avatar });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

changePassword

修改密码

changePassword({params}, callback(ret))

params

newPassword：

• 类型：字符串
• 描述：新密码

oldPassword：

• 类型：字符串
• 描述：旧密码

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,        //布尔型 true||false
    msg:""                //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.changePassword({
        oldPassword:"123",
        newPassword:"321"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

logout

注销

logout(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,        //布尔型 true||false
    msg:""                //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.logout(
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

bindPhone

将电话号码绑定为一种登录方式

bindPhone({params}, callback(ret))

params

country：

• 类型：字符串
• 描述：国家代码，如：中国对应86

phone：

• 类型：字符串
• 描述：手机号码

vcode：

• 类型：字符串
• 描述：手机验证码

password：

• 类型：字符串
• 描述：密码

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,        //布尔型 true||false
    msg:""                //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.bindPhone({
        country:"86",
        phone:"1xxxxxxxxxx",
        vcode:"0000",
        password:"123"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

bindSocialAccount

将指定社交平台绑定为一种登录方式

bindSocialAccount({params}, callback(ret))

params

Social：

• 类型：字符串
• 描述：社交平台，支持四种
• 取值范围：
  • Wechat（微信）
  • QQ（QQ）
  • SinaWeibo（新浪微博）
  • Facebook（脸书）

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,        //布尔型 true||false
    msg:""                //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.bindSocialAccount({
        Social:"SinaWeibo"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getLoginUserToken

获取登录用户token，同步函数

getLoginUserToken()

示例代码

    var mobUms = api.require("mobUms");
    api.alert({ msg: mobUms.getLoginUserToken() });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getLoginUserId

获取登录用户userId，同步函数

getLoginUserId()

示例代码

    var mobUms = api.require("mobUms");
    api.alert({ msg: mobUms.getLoginUserId() });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isBindPhone

是否已绑定手机号

isBindPhone(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,        //布尔型 true||false
    BindPhone:true,        //布尔型 是否绑定
    msg:""                //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.isBindPhone(
        function(ret) {
            if(ret.status) {
                api.alert({ msg: "绑定状态:"+ret.BindPhone+"\r\nmsg:"+ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getLoginUser

获取当前登录用户信息

getLoginUser(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
    id:"",                    //用户id
    phone:"1xxxxxxxxxx",    //手机号
    nickname:"王三",            //昵称
    avatarId:["","",""],    //数组 头像的大中小图片链接
    gender:"保密",            //性别
    birthday:"2000-01-10",    //生日
    age:1,                    //年龄
    constellation:"狮子座",    //星座
    zodiac:"牛",                //生肖
    signature:"我的签名",    //签名
    email:"123@qq.com",        //电子邮箱
    address:"北京",            //地址
    zipCode:100010,            //邮政编码
    resume:"简介",            //简介
    customize:{                //自定义字段
        csString:"测试数据",    //键值对形式，键为自定义字段的字段名
        csNumber:123,
        csDate:"2001-01-11"
    }
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.getLoginUser(
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

followUser

关注某个用户

followUser({params}, callback(ret))

params

id：

• 类型：字符串
• 描述：用户id，优先使用

phone：

• 类型：字符串
• 描述：手机号码，如果有id将忽略

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.followUser({
        phone:"1xxxxxxxxxx"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

stopFollow

取消关注

stopFollow({params}, callback(ret))

params

id：

• 类型：字符串
• 描述：用户id，优先使用

phone：

• 类型：字符串
• 描述：手机号码，如果有id将忽略

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.stopFollow({
        phone:"1xxxxxxxxxx"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteFans

删除粉丝，目前SDK删不掉，所以该函数无效，写上来做保留

deleteFans({params}, callback(ret))

params

id：

• 类型：字符串
• 描述：用户id，优先使用

phone：

• 类型：字符串
• 描述：手机号码，如果有id将忽略

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.deleteFans({
        phone:"1xxxxxxxxxx"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isMyFollowing

判断一个人是否我的关注

isMyFollowing({params}, callback(ret))

params

id：

• 类型：字符串
• 描述：用户id，优先使用

phone：

• 类型：字符串
• 描述：手机号码，如果有id将忽略

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.isMyFollowing({
        phone:"1xxxxxxxxxx"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isMyFans

判断一个人是否我的粉丝

isMyFans({params}, callback(ret))

params

id：

• 类型：字符串
• 描述：用户id，优先使用

phone：

• 类型：字符串
• 描述：手机号码，如果有id将忽略

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.isMyFans({
        phone:"1xxxxxxxxxx"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getFieldUser

通过字段值查找一个用户信息，如果用第三方平台注册，再绑定手机号，通过手机号查找是找不到的，目前SDK是这样，所以最好用手机注册，之后绑定第三方就没有此问题

getFieldUser({params}, callback(ret))

params

field：

• 类型：字符串
• 描述：等查找字段名，只支持默认字段的部分，如：”头像id”,”性别”,”生日”,”星座”,”生肖”，等不支持

value：

• 类型：根据字段数据类型决定
• 描述：等查找字段值，等于该值

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
    id:"",                    //用户id
    phone:"1xxxxxxxxxx",    //手机号
    nickname:"王三",            //昵称
    avatarId:["","",""],    //数组 头像的大中小图片链接
    gender:"保密",            //性别
    birthday:"2000-01-10",    //生日
    age:1,                    //年龄
    constellation:"狮子座",    //星座
    zodiac:"牛",                //生肖
    signature:"我的签名",    //签名
    email:"123@qq.com",        //电子邮箱
    address:"北京",            //地址
    zipCode:100010,            //邮政编码
    resume:"简介",            //简介
    customize:{                //自定义字段
        csString:"测试数据",    //键值对形式，键为自定义字段的字段名
        csNumber:123,
        csDate:"2001-01-11"
    }
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.getFieldUser({
        field:"phone",
        value:"1xxxxxxxxxx"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getFollowingsId

获取关注列表，只返回用户id数组，注意该函数可能数据量较大

getFollowingsId(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
    followNum:1,            //关注数量
    followingsId:[            //关注列表，用户id数组
        "","",""
    ]
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.getFollowingsId(
        function(ret) {
            if(ret.status) {
                api.alert({ msg: "关注数量:"+ret.followNum+"\r\n关注列表:"+ret.followingsId+"\r\n"+ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getFansId

返回粉丝列表，只返回用户id数组，注意该函数可能数据量较大

getFansId(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
    fansNum:1,                //关注数量
    fansId:[                //关注列表，用户id数组
        "","",""
    ]
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.getFansId(
        function(ret) {
            if(ret.status) {
                api.alert({ msg: "关注数量:"+ret.followNum+"\r\n关注列表:"+ret.followingsId+"\r\n"+ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getVerificationCode

请求获取短信验证码

getVerificationCode({params}, callback(ret))

params

country：

• 类型：字符串
• 描述：国家代码，如：中国对应86

phone：

• 类型：字符串
• 描述：手机号码

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.getVerificationCode({
        country:"86",
        phone:"1xxxxxxxxxx"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

submitVerificationCode

验证短信验证码

submitVerificationCode({params}, callback(ret))

params

country：

• 类型：字符串
• 描述：国家代码，如：中国对应86

phone：

• 类型：字符串
• 描述：手机号码

code：

• 类型：字符串
• 描述：手机验证码，注意这个参数和前面验证码参数 vcode 不同

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:true,            //布尔型 true||false
    msg:""                    //返回的文本信息
}

示例代码

    var mobUms = api.require("mobUms");
    mobUms.submitVerificationCode({
        country:"86",
        phone:"1xxxxxxxxxx",
        code:"0000"
        },
        function(ret) {
            if(ret.status) {
                api.alert({ msg: ret.msg });
            } else {
                api.alert({ msg: ret.msg });
            }
        }
    );

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本