Class IYYIM
Extends
IYYCommon.
聊天接口。提供弹出聊天对话框,弹出添加好友对话框等功能。
Defined in: yyapi.js.
Constructor Attributes | Constructor Name and Description |
---|---|
IYYIM()
IYYIM 构造函数
|
Method Attributes | Method Name and Description |
---|---|
addFriend(uid)
弹出添加好友对话框,用户确认才开始添加。
|
|
chatTo(uid, msg)
给指定用户发送聊天消息, 调用后会弹出聊天对话框,需要用户点击确认才发送。
|
|
获取我所有好友的uid信息。
|
|
getIMUserInfo(uid)
获取我指定的好友的详细信息。目前只能返回uid,YY号和昵称这三个信息。好友不在线也可以取到信息。
|
|
isFriend(uid)
判断指定的用户是否是好友。
|
- Methods borrowed from class IYYCommon:
- addEventListener, removeEventListener
Method Detail
{Object}
addFriend(uid)
弹出添加好友对话框,用户确认才开始添加。
- Parameters:
- {Number} uid
- 用户的唯一标识id,即uid,不是YY号 。
- Returns:
- 返回调用是否成功,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
{Object}
chatTo(uid, msg)
给指定用户发送聊天消息, 调用后会弹出聊天对话框,需要用户点击确认才发送。
- Parameters:
- {Number} uid
- 用户的唯一标识id,即uid,不是YY号 。
- {String} msg
- 等待发送的聊天的内容,最大长度40个字节。
- Returns:
- 返回调用是否成功,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
{Object}
getAllBuddyList()
获取我所有好友的uid信息。
使用示例: var result = yy.im.getAllBuddyList(); if(result.ret==0) { document.getElementById("txtLog").innerHTML = "我的好友个数:" + result.buddyList.length; document.getElementById("txtLog").innerHTML = "
我的好友为:" + result.buddyList; } 成功的返回值示例:{ ret:0,isFriend:true} 失败的返回值示例:{ ret:984832}
- Returns:
- 返回所有好友的uid,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
buddyList: Array类型 所有好友的uid ,uid保存在一个数组中 ,没有好友返回空数组
{Object}
getIMUserInfo(uid)
获取我指定的好友的详细信息。目前只能返回uid,YY号和昵称这三个信息。好友不在线也可以取到信息。
使用示例: var result = yy.im.getIMUserInfo(43465465); if(result.ret==0) { document.getElementById("txtLog").innerHTML = "好友的uid:" + result.uid; document.getElementById("txtLog").innerHTML = "
好友的昵称:" + result.name; document.getElementById("txtLog").innerHTML = "
好友的YY号:" + result.imId; } 成功的返回值示例:{ ret:0,uid:12345678,imId:987654321,name:"美羊羊"} 失败的返回值示例:{ ret:984832}
- Parameters:
- {Number} uid
- 要查询的好友的uid。
- Returns:
- 返回好友的信息,是Object对象,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
uid: Number类型 好友的uid
imId: Number类型 好友的YY号
name: String类型 好友的昵称
{Object}
isFriend(uid)
判断指定的用户是否是好友。
使用示例: var result = yy.im.isFriend(3454365); if(result.ret==0) { document.getElementById("txtLog").innerHTML = "和用户3454365关系:" + result.isFriend?"好友:"非好友"; } 成功的返回值示例:{ ret:0,isFriend:true} 失败的返回值示例:{ ret:984832}
- Parameters:
- {Number} uid
- 指定用户的唯一标识id,即uid,不是YY号 。
- Returns:
- 返回是否是好友,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
isFriend: Boolean类型 是否是好友 ,true=是好友 false=不是好友