虎牙开放平台文档

hyExt.context.onOpenNobleNotice

  • 监听开通贵族
  • 引入版本 1.7.0
  • 适用终端
    • 虎牙直播主站
    • 虎牙直播APP-iOS:7.13.353
    • 虎牙直播APP-安卓:7.13.6
    • 虎牙直播助手-iOS:4.7.6
    • 虎牙直播助手-安卓:4.7.6
    • 虎牙直播PC客户端-主播侧:4.18.4.0
    • 虎牙直播PC客户端-观众侧:未验证

接口签名

declare namespace hyExt { module context { /** * 监听开通贵族 * @param params 输入参数 */ function onOpenNobleNotice(params: OnOpenNobleNoticeReq): Promise<void> } /** * 监听开通贵族参数 */ type OnOpenNobleNoticeReq = { /** * 监听开通贵族 */ callback: OpenNobleNoticeCallback } /** * 监听开通贵族 * @param notice 开启贵族消息 */ type OpenNobleNoticeCallback = (notice: OpenNobleNotice) => void /** * 开启贵族消息 */ type OpenNobleNotice = { /** * 贵族生效unix时间戳,单位是秒 */ startTime: number /** * 贵族失效unix时间戳,单位是秒 */ endTime: number /** * 标志;取值说明: * 1 首次(非贵族开通任一贵族,或者低等级贵族更换高等级的贵族操作,都并入到首开); * 2 续费; */ openFlag: number /** * 开通月数 */ months: number /** * 贵族等级 */ nobleLevel: number /** * 贵族等级类型 */ nobleAttrType: number /** * 贵族名 */ nobleName: string /** * 房间Id */ roomId: number /** * 用户unionId */ unionId: string /** * 用户头像 */ userAvatarUrl: string /** * 用户昵称 */ userNick: string } }

示例代码

hyExt.context .onOpenNobleNotice({ callback: (notice) => { const { startTime, endTime, openFlag, months, nobleLevel, nobleAttrType, nobleName, roomId, unionId, userAvatarUrl, userNick, } = notice console.log("回调触发", notice) }, }) .then(() => { console.log("调用hyExt.context.onOpenNobleNotice成功") }) .catch((err) => { console.log("调用hyExt.context.onOpenNobleNotice失败", err) })

相关链接