FishPi.js API Documentation - v0.1.30
    Preparing search index...

    Interface IChatRoomEvents

    interface IChatRoomEvents {
        all: (type: string, data: any) => void;
        barrager: (barrage: IBarragerMsg) => void;
        close: (event: CloseEvent) => void;
        custom: (msg: string) => void;
        discuss: (discuss: string) => void;
        error: (error: ErrorEvent) => void;
        msg: (msg: IChatRoomMsg) => void;
        music: (music: IChatRoomMsg<IMusicMessage>) => void;
        online: (onlines: IOnlineInfo[]) => void;
        open: (event: Event) => void;
        redPacket: (redpacket: IChatRoomMsg<IRedpacket>) => void;
        redPacketStatus: (status: IRedPacketStatusMsg) => void;
        revoke: (oId: string) => void;
        weather: (weather: IChatRoomMsg<IWeatherMessage>) => void;
    }

    Hierarchy

    • IWebSocketEvent
      • IChatRoomEvents
    Index

    Properties

    all: (type: string, data: any) => void

    发送所有消息

    Type Declaration

      • (type: string, data: any): void
      • Parameters

        • type: string

          消息类型

        • data: any

          消息内容

        Returns void

    barrager: (barrage: IBarragerMsg) => void

    弹幕消息

    Type Declaration

    close: (event: CloseEvent) => void

    Websocket 关闭

    custom: (msg: string) => void

    进出通知

    Type Declaration

      • (msg: string): void
      • Parameters

        • msg: string

          进出通知内容

        Returns void

    discuss: (discuss: string) => void

    话题变更

    Type Declaration

      • (discuss: string): void
      • Parameters

        • discuss: string

          话题

        Returns void

    error: (error: ErrorEvent) => void

    Websocket 错误

    msg: (msg: IChatRoomMsg) => void

    聊天消息

    Type Declaration

    music: (music: IChatRoomMsg<IMusicMessage>) => void

    音乐消息

    Type Declaration

    online: (onlines: IOnlineInfo[]) => void

    在线用户变更

    Type Declaration

    open: (event: Event) => void

    Websocket 打开

    redPacket: (redpacket: IChatRoomMsg<IRedpacket>) => void

    红包消息

    Type Declaration

    redPacketStatus: (status: IRedPacketStatusMsg) => void

    红包领取

    Type Declaration

    revoke: (oId: string) => void

    撤回消息

    Type Declaration

      • (oId: string): void
      • Parameters

        • oId: string

          被撤回消息 oId

        Returns void

    weather: (weather: IChatRoomMsg<IWeatherMessage>) => void

    天气消息

    Type Declaration