Class Index | File Index

Classes


Class IYYUser


Extends IYYCommon.
用户信息接口。提供获取用户的信息,接收用户信息变化事件等功能。
Defined in: yyapi.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
IYYUser 构造函数。
Field Summary
Field Attributes Field Name and Description
<static>  
当前用户信息变更事件。当前用户昵称,性别,签名,马甲修改的时候会触发此事件。
Method Summary
Method Attributes Method Name and Description
 
获取当前用户的信息。
 
获取指定的用户的信息。指定的用户必须在当前大频道中。
 
rename(newName)
修改用户昵称。调用此接口修改自己的昵称。两次调用必须间隔1秒以上。
Methods borrowed from class IYYCommon:
addEventListener, removeEventListener
Class Detail
IYYUser()
IYYUser 构造函数。
Field Detail
<static> IYYUser.USER_INFO_CHANGED
当前用户信息变更事件。当前用户昵称,性别,签名,马甲修改的时候会触发此事件。
侦听函数格式: function(eventData){    } 
eventData: Object类型 变化后的用户信息。
使用示例:
yy.user.addEventListener(IYYUser.USER_INFO_CHANGED,onChange);

function onChange(eventData)
{
   document.getElementById("txtLog").innerHTML=eventData.name+ "的信息发生了变化";
}
See:
#getCurrentChannelInfo
Method Detail
{Object} getCurrentUserInfo()
获取当前用户的信息。
使用示例:
var userInfo = yy.user.getCurrentUserInfo();
成功的返回值示例:{ ret:0,uid:249267551,name:"美羊羊",vip:false,points:4125,imId:293451745,sex:0,sign:"很困了想睡觉",level:128,role:25,vipLevel:0,contribution:0}
失败的返回值示例:{ ret:984832}
Returns:
返回当前用户信息,是一个Object对象。具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
uid: Number类型 用户的uid,唯一标识id。
imId: Number类型 用户的YY号。
level: String类型 用户的等级。
name: Number类型 用户的名称。
role: Number类型 用户的马甲 对应的信息如下:
无效角色 0
未知用户 灰马 20
游客(U) 白马 25
临时嘉宾(G) 浅绿色马甲 66
嘉宾(VIP) 绿马 88
会员(R) 蓝马 100
二级子频道管理员(CA2) 粉马 150
子频道管理员(CA) 红马 175
全频道管理员(MA) 黄马 200
频道总管理(VP) 橙马 230
频道所有者(OW) 紫马 255
客服 300
歪歪官方人员 黑马 1000 。
sex: Number类型 用户的性别 0=女 1=男 。
sign: String类型 用户的签名。
vip: Boolean类型 是否是会员trur=会员,false=非会员。
vipLevel: Number类型 游会员的等级。
points: Number类型 用户的个人积分。
contribution: Number类型 用户对当前频道的贡献值。

{Object} getUserInfo(uid)
获取指定的用户的信息。指定的用户必须在当前大频道中。
Parameters:
{Number} uid
用户的唯一标识id,即uid,不是YY号
Returns:
返回指定用户信息,是一个Object对象。返回信息的格式同getCurrentUserInfo接口一致。
See:
#getCurrentUserInfo

{Object} rename(newName)
修改用户昵称。调用此接口修改自己的昵称。两次调用必须间隔1秒以上。
Parameters:
{String} newName
用户的新昵称,用户昵称需要符合相关要求。
Returns:
返回调用是否成功,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

Documentation generated by JsDoc Toolkit 2.4.0