# init

初始化融云 SDK，调用 connect 连接前务必保证调用此方法

#### 调用前请在 config.xml 中设置内容如下：

~~~

~~~

其中 value 的值请替换为您在融云开发者平台上申请的 App Key 值

init(callback(ret, err))

callback(ret, err)

ret:

类型：JSON 对象

描述：初始化的状态，如果 config.xml 中没有设置 appKey 值，会导致失败，错误信息为参数错误

内部字段：

~~~

{

status: 'success', // 状态码：success / error

}

~~~

err:

类型：JSON 对象

内部字段：

~~~

{

code: -10002 // 错误码

}

~~~

错误说明：

~~~

错误码说明

-10002输入参数错误

~~~

示例代码

~~~

var rong = api.require('rongCloud2');

rong.init(function(ret, err) {

if (ret.status == 'error')

api.toast({ msg: err.code });

});

~~~

可用性

iOS系统，Android系统

可提供的 1.1.0 及更高版本

# connect

连接融云 IM 服务器，进行后续各种方法操作前务必要先调用此方法

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

params

token:

类型：字符串

默认值：无

描述：从服务端获取的用户身份令牌(Token)

callback(ret, err)

ret:

类型：JSON 对象

描述：返回的登录成功或者失败的状态

内部字段：

{

status: 'success', // 状态码：success / error

result:

{

userId: '9527' // 当前登录的用户 Id

}

}

err:

类型：JSON 对象

内部字段：

{

code: 31004 // 错误码

}

错误说明：

~~~

错误码说明

31003服务器不可用

31004错误的令牌(Token)，Token 解析失败，请重新向身份认证服务器获取 Token

31002可能是错误的 App Key，或者 App Key 被服务器积极拒绝

33002服务端数据库错误

31000服务器超时

-10000未调用 init 方法进行初始化

-10002输入参数错误

-1000(此错误只发生在 ios)当已经 connect 成功后再次 connect 时会返回此错误

~~~

示例代码

~~~

var rong = api.require('rongCloud2');

rong.init(function(ret, err) {

if (ret.status == 'error')

api.toast({ msg: err.code });

});

rong.connect({

token: 'ThptTWyiPPPvZHvuSiuri82yq+hfEluLjZ78E1qo4hEVSFQNpqdoPu406urMWKN4Z3/olWR+v9JVLAwfOQoLrA=="},function(ret, err) {

if (ret.status == 'success') api.toast({ msg: ret.result.userId });

});

~~~

可用性

iOS系统，Android系统

可提供的 1.1.0 及更高版本

# disconnect

断开连接

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

params

isReceivePush:

类型：布尔

默认值：true

描述：断开后是否接收 Push

callback(ret, err)

ret:

类型：JSON 对象

描述：返回的断开连接成功或者失败的状态

内部字段：

~~~

{

status: 'success' // 状态码：success

}

~~~

示例代码

~~~

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.disconnect({

isReceivePush: true

}, function(ret, err) {

if ('success' == ret.status) {

api.toast({ msg: '断开连接成功!' });

}

}); // 断开，且不再接收 Push

~~~

可用性

iOS系统，Android系统

可提供的 1.1.0 及更高版本

# setConnectionStatusListener

设置连接状态变化的监听器，请在调用 init 方法之后，调用 connect 方法之前设置

setConnectionStatusListener(callback(ret, err))

callback(ret, err)

ret:

类型：JSON 对象

描述：连接服务器的回调返回值，参见 连接状态

内部字段：

~~~

{

result:

{

connectionStatus: 'CONNECTED' // 连接状态

}

}

~~~

示例代码

~~~

var rong = api.require('rongCloud2');

// 之前调用 init 的代码省略

rong.setConnectionStatusListener(function(ret, err) {

api.toast({ msg: ret.result.connectionStatus });

});

// 之后调用 connect 的代码省略

~~~

可用性

iOS系统，Android系统

可提供的 1.1.0 及更高版本

# logout

注销登录(不再接收 Push 消息)

logout(callback(ret, err))

callback(ret, err)

ret:

类型：JSON 对象

描述：返回的注销登录成功或者失败的状态

内部字段：

~~~

{

status: 'success' // 状态码：success

}

~~~

示例代码

~~~

var rong = api.require('rongCloud2');

// 之前调用 init 和 connect 的代码省略

rong.logout(function(ret, err) {

if (ret.status == 'error')

api.toast({ msg: err.code });

}); // 断开，且不再接收 Push

~~~

可用性

iOS系统，Android系统

可提供的 2.0.0 及更高版本

* * * * *

## 连接状态

连接状态，字符串类型

### 取值范围

* CONNECTED // 连接成功

* CONNECTING // 连接中

* DISCONNECTED // 断开连接

* KICKED // 用户账户在其他设备登录，本机会被踢掉线

* NETWORK_UNAVAILABLE // 网络不可用

* SERVER_INVALID // 服务器异常或无法连接

* TOKEN_INCORRECT // Token 不正确

### 可用性

iOS系统，Android系统

可提供的 2.0.0 及更高版本