Class Index | File Index

Classes


Class IYYChannelAppMsg


Extends IYYCommon.
频道应用消息接口,提供频道的应用消息发送和响应等操作,应用消息出现在应用盒子的应用消息选项卡中和公告栏下方。
Defined in: yyapi.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
IYYChannelAppMsg 构造函数
Field Summary
Field Attributes Field Name and Description
<static>  
IYYChannelAppMsg.APP_LINK_CLICKED
应用消息链接点击事件。应用消息中的超链接被点击的时候会触发。
<static>  
IYYChannelAppMsg.APP_LINK_EX_CLICKED
应用消息链接点击事件。应用消息中的超链接被点击的时候会触发。
Method Summary
Method Attributes Method Name and Description
 
sendMsgToSubChannel(subChannelId, msg, linkstart, linkend, token)
发送应用消息到子频道。所有该子频道在线用户才能收到。
 
sendMsgToSubChannelEx(subChannelId, token, key, textData)
发送应用消息到子频道。所有该子频道在线用户才能收到。可以发送包含多个链接的消息。
 
sendMsgToUsers(userList, msg, linkstart, linkend, token)
发送应用消息给指定用户。用户必须在同一大频道中,且必须在线才能收到。
 
sendMsgToUsersEx(userList, token, key, textData)
发送应用消息给指定用户。用户必须在同一大频道中,且必须在线才能收到。可以发送包含多个链接的消息。
Methods borrowed from class IYYCommon:
addEventListener, removeEventListener
Class Detail
IYYChannelAppMsg()
IYYChannelAppMsg 构造函数
Field Detail
<static> IYYChannelAppMsg.APP_LINK_CLICKED
应用消息链接点击事件。应用消息中的超链接被点击的时候会触发。
侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.token: Number类型,发送消息的时候设置的token,可以用来判断哪一条消息被点击。
使用示例:
yy.channel.appMsg.addEventListener(IYYChannelAppMsg.APP_LINK_CLICKED,onLinkClicked);

function onLinkClicked(eventData)
{
    document.getElementById("txtLog").innerHTML="消息的Token="+eventData.token;
}

<static> IYYChannelAppMsg.APP_LINK_EX_CLICKED
应用消息链接点击事件。应用消息中的超链接被点击的时候会触发。
侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.token: Number类型,发送消息的时候设置的token,可以用来判断哪一条消息被点击。
eventData.userData: Number类型,发送消息的时候链接里设置的userData值。
使用示例:
yy.channel.appMsg.addEventListener(IYYChannelAppMsg.APP_LINK_EX_CLICKED,onLinkExClicked);

function onLinkExClicked(eventData)
{
    document.getElementById("txtLog").innerHTML="消息的Token="+eventData.token+" userData="+eventData.userData;
}
Method Detail
{Object} sendMsgToSubChannel(subChannelId, msg, linkstart, linkend, token)
发送应用消息到子频道。所有该子频道在线用户才能收到。
Parameters:
{Number} subChannelId
子频道长位id。
{String} msg
消息内容,最大长度200字节。
{Number} linkstart
内容中超链接开始位置,必须为正整数。
{Number} linkend
内容中超链接结束位置,必须为正整数。
{Number} token
设置token,消息标记,必须为正整数。
Returns:
返回调用是否成功,是一个Object对象,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

{Object} sendMsgToSubChannelEx(subChannelId, token, key, textData)
发送应用消息到子频道。所有该子频道在线用户才能收到。可以发送包含多个链接的消息。
Parameters:
{Number} subChannelId
子频道长位id。
{Number} token
设置token,消息标记,必须为正整数。
{String} key
消息的认证key,根据消息内容和应用Id计算出的key,应用通过审核后,可以在open.yy.com获取。
{Array} textData
包含文字信息的数组,数组每个元素是json对象,示例如下。
[{ text: "嘎嘎鱼", type: 2, userData: 87639876 }, { text: "邀请全部子频道的人一起玩", type: 1 }, { text: "猜骰子", type: 2, userData: 105620}]
数组中每个元素的格式:
text: 文字信息
type: 是普通文字还是链接文字,1=普通文字 2=链接文字 其他值无效
userData: 如果是链接文字,userData保存链接自定义数据,是一个正整数,点击链接的时候可以得到此数据,如果是普通文字可以没有此属性
Returns:
返回调用是否成功,是一个Object对象,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

{Object} sendMsgToUsers(userList, msg, linkstart, linkend, token)
发送应用消息给指定用户。用户必须在同一大频道中,且必须在线才能收到。
Parameters:
{Array} userList
存有目标用户uid的数组。
{String} msg
消息内容 最大长度200字节。
{Number} linkstart
内容中超链接开始位置,必须为正整数。
{Number} linkend
内容中超链接结束位置,必须为正整数。
{Number} token
设置token,消息标记,必须为正整数。
Returns:
返回调用是否成功,是一个Object对象,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

{Object} sendMsgToUsersEx(userList, token, key, textData)
发送应用消息给指定用户。用户必须在同一大频道中,且必须在线才能收到。可以发送包含多个链接的消息。
Parameters:
{Array} userList
存有目标用户uid的数组。
{Number} token
设置token,消息标记,必须为正整数。
{String} key
消息的认证key,根据消息内容和应用Id计算出的key,应用通过审核后,可以在open.yy.com获取。
{Array} textData
包含文字信息的数组,数组每个元素是json对象。格式同sendMsgToSubChannelEx。
Returns:
返回调用是否成功,是一个Object对象,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
See:
#sendMsgToSubChannelEx

Documentation generated by JsDoc Toolkit 2.4.0