投票
#调用域: HT.plugins().vote
监听:vote:new
@说明: 发起投票的广播
返回参数 | 描述 |
---|---|
cmd | vote:new 指令名称 |
args | args.vid:投票ID;args.optional:可选几项;args.opList:选项列表;args.info.title:投票主题;args.info.label:投票标签;args.info.nickname:发起者昵称;args.info.startTime:投票发起时间;args.info.gid:分组ID;args.info.role:发起者身份;args.info.answer:答案 |
监听:vote:pub
@说明: 投票结束的广播
返回参数 | 描述 |
---|---|
cmd | vote:pub 指令名称 |
args | args.info.answer: 投票的正确答案,返回值是从0开始的索引;args.info.bid: 主播id;args.info.endTime: 投票结束的时间;args.info.imageUrl: 图片投票的图片地址;args.info.label: 投票的标签内容;args.info.nickname: 投票发起者昵称;args.info.optional: 投票可选几项;args.info.noticeTime: 投票的发起时间;args.info.role: 投票发起者的身份;args.info.startTime: 投票发起时间;args.info.status:投票的状态;args.info.title: 投票的主题;args.info.uid: 投票发起者的uid;args.info.vid: 投票id |
isShow | 是否公布投票结果,1为公布,0为不公布 |
rightUser | 投票结果正确的用户数组,avatar: 用户的头像;nickname: 用户的昵称;option: 用户选择的选项,返回值是从1开始的索引,time: 用户提交选项的时间;uid: 用户uid;xid: 用户xid |
statsList | 投票结果统计数组,数组的长度代表选项个数,数组第零个代表A选项,第一个代表B选项...以此类推,数组每一项中op: 选项的内容;opNum: 选择此选项的用户个数;percent: 选择该选项的用户比例 |
total | 此次投票的用户总数 |
方法:voteList
@说明: 学生获取投票列表
参数 | 描述 callback| 回调,在回调中会返回请求的结果
示例:
voteList((res) => {
console.log(res)
})
返回值 | 描述 |
---|---|
code | 状态值,0表示成功 |
data | 投票数据,data.votes: 投票列表数组,数组长度为投票的总个数,数组中每一项中cmd: 投票指令;info: 每项投票具体信息;opList: 投票选项数组,数组长度为选项个数,数组第零个表示A的值,第二个表示B的值,以此类推;optional: 正确选项的个数;vid: 投票id;voted: 是否投过票 |
data.info | 投票详情,data.info.answer: 投票的正确答案;data.info.endTime: 投票结束的时间;data.info.imageUrl: 图片投票的图片地址;data.info.label: 投票的标签内容;data.info.nickname: 投票发起者昵称;data.info.noticeTime: 投票的发起时间;data.info.role: 投票发起者的身份;data.info.startTime: 投票发起时间;data.info.status:投票的状态;data.info.title: 投票的主题; |
方法:voteDetail
@说明: 学生获取某个投票的详情
参数 | 描述 |
---|---|
data | 必须参数,类型为Object,Object需要vid属性,为需要获取详情的投票id |
callback | 回调,在回调中会返回请求的结果 |
示例:
voteDetail({vid: 1234}, (res) => {
// 获取vid为1234的投票详情
console.log(res)
})
返回值 | 描述 |
---|---|
code | 状态值,0表示成功 |
info | 投票详情数据,info.answer: 投票的正确答案,返回值是从0开始的索引, |
isShow | 是否公布投票结果 |
rightUser | 投票正确的用户数组 |
statsList | 投票结果统计数组,数组的长度代表选项个数,数组第零个代表A选项,第一个代表B选项...以此类推,数组每一项中op: 选项的内容;opNum: 选择此选项的用户个数;percent: 选择该选项的用户比例 |
user | 参与投票的用户数组 |