虎牙开放平台文档

接口名

hyExt.pk.onInviteMessage

说明

监听弹幕玩法邀请事件

适用平台

平台	是否适用
Web	否
虎牙直播APP	否
虎牙直播PC客户端	否
虎牙直播PC主播端	是
虎牙助手APP	是

例子

hyExt.pk.onInviteMessage({
  callback: ({ name, message }) => {
    hyExt.logger.info('弹幕玩法邀请事件触发：' + JSON.stringify(message))
  }
}).then(() => {
  hyExt.logger.info('监听弹幕玩法邀请事件成功')
}).catch(err => {
  hyExt.logger.warn('监听弹幕玩法邀请事件失败：' + err.message)
})

输入

参数	类型	说明
req	Object	输入参数

其中输入参数的结构为

字段	类型	说明
callback	(notice:PkNotice) => void	消息回调函数

其中PkNotice的结构为：

字段	类型	说明
name	string	事件名，PkInvite-发起邀请；PkResponseInvite-接受/拒绝邀请；PKInviteTimeout-邀请结束
message	PkInviteNotice\|PkResponseInvite\|PKInviteTimeoutNotice	事件数据

其中message的结构为：

字段	类型	说明
noticeType	number	通知类型 1-邀请；2-回复
inviteInfo	InviteInfo	邀请信息
customParamMap	Map<string, string>	小程序自定义参数

其中InviteInfo的结构为：

字段	类型	说明
inviteId	string
extUuid	string	被邀请的游戏
inviteState	number	邀请状态，0-未邀请；1-邀请中尚未同意；2-同意；3-拒绝；99-邀请失败
inviterUnionId	string	邀请者unionId
inviteeUnionId	string	被邀请者unionId
remainTime	number	邀请倒计时，单位是秒
inviterInfo	InviteUserInfo	邀请者信息
inviteeInfo	InviteeUserInfo	被邀请者信息

其中邀请者信息的结构为：

字段	类型	说明
inviteUnionId	string	邀请者unionId
inviteNickName	string	邀请者昵称
inviteAvatarUrl	string	邀请者头像

其中被邀请者信息的结构为：

字段	类型	说明
inviteeUnionId	string	被邀请者unionId
inviteeNickName	string	被邀请者昵称
inviteeAvatarUrl	string	被邀请者头像

输出

参数	类型	说明
promise	Promise	返回Promise

其中resolve的数据为空