虎牙开放平台文档

hyExt.context.onOpenGuardianNotice

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

接口签名

declare namespace hyExt { module context { /** * 监听开通守护 * @param params 输入参数 */ function onOpenGuardianNotice(params: OpenGuardianNoticeReq): Promise<void> } /** * 监听开通守护参数 */ type OpenGuardianNoticeReq = { /** * 开通守护回调 */ callback: OpenGuardianNoticeCallback } /** * 开通守护回调 * @param notice 开启守护消息 */ type OpenGuardianNoticeCallback = (notice: OpenGuardianNotice) => void /** * 开启守护消息 */ type OpenGuardianNotice = { /** * 开通或者续费天数 */ openDays: number /** * 开通或者续费之前的守护等级 */ lastGuardianLevel: number /** * 开通或续费后守护等级 */ openGuardianLevel: number /** * 主播昵称 */ presenterNick: string /** * 房间Id */ roomId: number /** * 用户unionId */ unionId: string /** * 用户头像 */ userAvatarUrl: string /** * 用户昵称 */ userNick: string /** * 守护类型;取值说明: 0 初爱守护; 2 超级守护; 3 至尊守护; */ guardType: number } }

示例代码

hyExt.context .onOpenGuardianNotice({ callback: (notice) => { const { openDays, lastGuardianLevel, openGuardianLevel, presenterNick, roomId, unionId, userAvatarUrl, userNick, guardType, } = notice console.log("回调触发", notice) }, }) .then(() => { console.log("调用hyExt.context.onOpenGuardianNotice成功") }) .catch((err) => { console.log("调用hyExt.context.onOpenGuardianNotice失败", err) })

相关链接