游云SDK for Cordova API

游云SDK for Cordova API

游云SDK for Cordova ，专注为互联网、移动互联网开发者提供即时通讯基础能力和云端服务。使开发者不必搭建服务端硬件环境，就可以将即时通讯、实时网络能力快速集成至应用中。

使用

youyun-plugin-im

模块之前，请先 注册 游云的开发者帐号并申请创建 App，成功创建 App 后，可以在 开发者后台 获取

App ClientID

和

App Secret

用于开发，并修改

plugin.xml

文件中相应字段。

注意:

iOS 使用游云SDK之前要确保

public.der

文件成功添加到Xcode工程目录下，否则将无法使用所有功能。

1. 登录

登录SDK方法login(success, failed, params)。

success 、failed

类型：function(result)

描述：成功/失败调用回调方法

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result"：{
"id" : "用户ID"
}
}

示例

YouYunIMPlugin.login(success, failed, {});

2. 登出

登出SDK方法 logout(success, failed, params)。

success 、failed

类型：function(result)

描述：成功/失败调用回调方法

内部字段：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" " {}
}

示例

YouYunIMPlugin.logout(success, failed, {});

3. 创建群组

创建群组方法 groupCreate(success, failed, params)。

success 、failed

类型：function(result)

描述：创建群组成功／失败状态反馈

内部字段：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {
"groupID" : "创建的群组ID"
}
}

示例

YouYunIMPlugin.groupCreate(success, failed, {});

4. 添加群组成员

添加群组成员方法 groupAddUser(success, failed, params)，不是该群组的群主也可以正常添加其他群成员。

success/failed

类型：function(result)

描述：添加群成员成功／失败回调

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {}
}

params

类型：JSON对象

描述：添加群成员的接口参数，支持添加多人。

内部代码：

{
"groupID" : "要添加群组成员的群组ID",
"userIDs" : ["要添加的成员ID数组1"]
}

示例

YouYunIMPlugin.groupAddUser(success, failed, {"groupID":"150861", "userIDs":["139702","135259","140743"]});

5. 删除群成员

删除群成员方法 groupDeleteUser(success, failed, params), 不是该群组的群主也可以正常删除其他群成员。

success/failed

类型：function(result)

描述：删除群成员成功／失败回调

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {}
}

params

类型：JSON对象

描述：删除群成员的接口参数，支持删除多人。

内部代码：

{
"groupID" : "要删除群成员的群组ID"，
"userIDs" : ["要删除的群成员ID"]
}

示例

YouYunIMPlugin.groupDeleteUser(success, failed, {"groupID":"150861", "userIDs":["139702","135259","140743"]});

6. 获取群组成员列表

获取群组成员列表接口方法 groupGetTotalUsers(success, failed, params)。

success/failed

类型：function(result)

描述：获取群成员接口成功／失败回调

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {
"users" : ["群组成员ID"]
}
}

params

类型：JSON对象

描述：获取群成员的接口参数

内部代码：

{
"groupID" : "想获取群成员的群组ID"
}

示例

YouYunIMPlugin.groupGetTotalUsers(success, failed, {"groupID":"150861"});

7. 退出群组

退出群组的方法 groupExit(success, failed, params)。

success/failed

类型：function(result)

描述：退出群组接口成功／失败回调

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {}
}

params

类型：JSON对象

描述：退出群组的接口参数

内部代码：

{
"groupID": "要退出的群组ID"
}

8. 获取用户加入的群组列表

获取某一用户所加入的群组列表方法 groupGetUserGroups(success, failed, params)。

success/failed

类型：function(result)

描述：获取群列表接口成功／失败回调

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {
"groups" : ["群组ID"]
}
}

示例

YouYunIMPlugin.groupGetUserGroups(success, failed, {});

9. 发送单聊文本

给某一个用户发送单聊文本方法 sendText(success, failed, params)。

success/failed

类型：function(result)

描述：发送单聊接口成功／失败回调接口

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {}
}

params

类型：JSON对象

描述：发送单聊的接口参数

内部代码：

{
"userID" : "对方用户ID",
"content" : "文本消息内容",
"extContent" : "额外信息"
}

示例

YouYunIMPlugin.sendText(sendMsgSuccessCallback, function(){}, {"userID" : "140109", "content" : "Hello", "extContent" : ""});

10. 发送群聊文本

发送群聊文本方法 sendGroupText(success, failed, params)。

success/failed

类型：function(result)

描述：发送群聊接口成功／失败回调接口

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {}
}

params

类型：JSON对象

描述：发送单聊的接口参数

内部代码：

{
"groupID" : "群组ID",
"content" : "文本消息内容",
"extContent" : "额外信息"
}

示例

YouYunIMPlugin.sendGroupText(success, failed, {"groupID" : "150861", "content" : "Hello Group!", "extContent" : "" });

11. 发送单聊图片

发送给某一个用户图片方法 sendPic(success, failed, params)。

success/failed

类型：function(result)

描述：发送单聊图片接口成功／失败回调接口

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {
"fileID" : "发送的图片ID"
}
}

params

类型：JSON对象

描述：发送单聊的接口参数

内部代码：

{
"userID" : "对方用户ID",
"filePath" : "原图文件路径",
"nailPath" : "缩略图文件路径",
"extContent" : "额外信息"
}

示例

var sendJson = {
"userID" : '140109',
"filePath" : '',
"nailPath" : ''
};
YouYunIMPlugin.sendPic(success, function(){}, sendJson);

12. 发送群组图片

发送群组图片方法 sendGroupImage(success, failed, params)。

success/failed

类型：function(result)

描述：发送群组图片接口成功／失败回调接口

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {
"fileID" : "发送的图片ID"
}
}

params

类型：JSON对象

描述：发送群组的接口参数

内部代码：

{
"groupID" : "群组ID",
"filePath" : "原图文件路径",
"nailPath" : "缩略图文件路径",
"extContent" : "额外信息"
}

示例

var sendJson = {
"groupID" : '150861',
"filePath" : '',
"nailPath" : ''
};
YouYunIMPlugin.sendGroupImage(success, function(){}, sendJson);

13. 下载图片

下载图片方法 getFile(success, failed, params)。

success/failed

类型：function(result)

描述：下载图片接口成功／失败回调接口

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {}
}

params

类型：JSON对象

描述：获取图片的接口参数

内部代码：

{
"fileID" : "文件ID",
"length" : "文件总长度",
"pieceSize" : "切片大小"
}

14. 服务器下发消息监听

接收服务器下发的消息方法 setRecieveMsgListener(success, failed, params)，所有接收到的消息、通知、状态都经由此处设置的监听器处理。

success/failed

类型：function(result)

描述：接收服务器下发消息的接口成功／失败回调接口

内部代码：

{
"status" : 1, // 1：成功 0：失败
"msg" : "", // 成功、错误信息
"result" : {
// TODO async message.
}
}

其中result包涵的SJON对象为具体的异步服务器下发消息，主要分为以下几类：

type = 1, // 单聊文本
type = 2, // 单聊图片
type = 3, // 群聊文本
type = 4, // 群聊图片
type = 5, // 上传进度
type = 6, // 下载进度
type = 7, // 下载完成

1. 接收单聊文本消息

收到服务器下发的单人对单人的单聊文本消息。

内部代码：

iOS：

{
"platform" : "iOS",
"result" : {
"content" : "收到文本消息内容",
"messageID" : "消息ID标识",
"fromUID" : "发送文本消息的用户ID",
"toUID" : "接收文本消息的用户ID",
"extContent" : "额外文本信息",
"timeValue" : "发送时间",
"type" : "异步消息类型"
}
}

2. 接收单聊文件／图片消息

收到服务器下发的单人对单人的单聊文件／图片消息。

内部代码：

iOS:

{
"platform" : "iOS",
"result" : {
"content" : "收到文本消息内容",
"messageID" : "消息ID标识",
"fromUID" : "发送文本消息的用户ID",
"toUID" : "接收文本消息的用户ID",
"fileID" : "文件ID",
"thumbnailData" : "缩略图文件的base64字符串",
"extContent" : "额外文本信息",
"timeValue" : "发送时间",
"length" : "文件大小",
"size" : "文件分片大小",
"type" : "异步消息类型"
}
}

3. 接收群聊文本消息

收到服务器下发的群组文本消息。

内部代码：

iOS：

{
"platform" : "iOS",
"result" : {
"content" : "收到文本消息内容",
"messageID" : "消息ID标识",
"fromUID" : "发送文本消息的用户ID",
"groupID" : "接收文本消息的群组ID",
"extContent" : "额外文本信息",
"timeValue" : "发送时间",
"type" : "异步消息类型"
}
}

4. 接收群组文件／图片消息

收到服务器下发的群组文件／图片消息。

内部代码：

iOS:

{
"platform" : "iOS",
"result" : {
"content" : "收到文本消息内容",
"messageID" : "消息ID标识",
"fromUID" : "发送文本消息的用户ID",
"groupID" : "接收文本消息的群组ID",
"fileID" : "文件ID",
"thumbnailData" : "缩略图文件的base64字符串",
"extContent" : "额外文本信息",
"timeValue" : "发送时间",
"length" : "文件大小",
"size" : "文件分片大小",
"type" : "异步消息类型"
}
}

5. 接收上传／下载文件进度

上传／下载文件进度。

内部代码：

iOS:

{
"platform" : "iOS",
"result" : {
"current" : "已接收／已发送文件大小",
"total" : "总文件大小",
"type" : "异步消息类型"
}
}

6. 接收文件／图片下载成功消息

文件／图片下载成功时的消息。

内部代码：

iOS:

{
"platform" : "iOS",
"result" : {
"fileID" : "文件ID",
"type" : "异步消息类型"
}
}