Interface ChatRoomEventListener

聊天室事件回调。

interface ChatRoomEventListener {
    onAdminAdded?(params: {
        admin: string;
        roomId: string;
    }): void;
    onAdminRemoved?(params: {
        admin: string;
        roomId: string;
    }): void;
    onAllChatRoomMemberMuteStateChanged?(params: {
        isAllMuted: boolean;
        roomId: string;
    }): void;
    onAllowListAdded?(params: {
        members: string[];
        roomId: string;
    }): void;
    onAllowListRemoved?(params: {
        members: string[];
        roomId: string;
    }): void;
    onAnnouncementChanged?(params: {
        announcement: string;
        roomId: string;
    }): void;
    onAttributesRemoved?(params: {
        from: string;
        removedKeys: string[];
        roomId: string;
    }): void;
    onAttributesUpdated?(params: {
        attributes: Map<string, string>;
        from: string;
        roomId: string;
    }): void;
    onDestroyed?(params: {
        roomId: string;
        roomName?: string;
    }): void;
    onMemberExited?(params: {
        participant: string;
        roomId: string;
        roomName?: string;
    }): void;
    onMemberJoined?(params: {
        ext?: string;
        participant: string;
        roomId: string;
    }): void;
    onMemberRemoved?(params: {
        participant?: string;
        reason?: string;
        roomId: string;
        roomName?: string;
    }): void;
    onMuteListAdded?(params: {
        expireTime?: string;
        mutes: string[];
        roomId: string;
    }): void;
    onMuteListRemoved?(params: {
        mutes: string[];
        roomId: string;
    }): void;
    onOwnerChanged?(params: {
        newOwner: string;
        oldOwner: string;
        roomId: string;
    }): void;
    onSpecificationChanged?(room: ChatRoom): void;
}

Methods

onAdminAdded? onAdminRemoved? onAllChatRoomMemberMuteStateChanged? onAllowListAdded? onAllowListRemoved? onAnnouncementChanged? onAttributesRemoved? onAttributesUpdated? onDestroyed? onMemberExited? onMemberJoined? onMemberRemoved? onMuteListAdded? onMuteListRemoved? onOwnerChanged? onSpecificationChanged?

Methods

OptionalonAdminAdded

  • onAdminAdded(params): void

  • 有成员设置为聊天室管理员的回调。

    Parameters

    • params: {
          admin: string;
          roomId: string;
      }
      • admin: string
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [admin] 设置为管理员的成员的用户 ID。

OptionalonAdminRemoved

  • onAdminRemoved(params): void

  • 移除聊天室管理员权限的回调。

    Parameters

    • params: {
          admin: string;
          roomId: string;
      }
      • admin: string
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [admin] 被移出管理员权限的成员的用户 ID。

OptionalonAllChatRoomMemberMuteStateChanged

  • onAllChatRoomMemberMuteStateChanged(params): void

  • 聊天室全员禁言状态变化回调。

    Parameters

    • params: {
          isAllMuted: boolean;
          roomId: string;
      }
      • isAllMuted: boolean
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [isAllMuted] 是否所有聊天室成员被禁言。
      • true：是；
      • false：否。

OptionalonAllowListAdded

  • onAllowListAdded(params): void

  • 有成员被加入聊天室白名单的回调。

    Parameters

    • params: {
          members: string[];
          roomId: string;
      }
      • members: string[]
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [members] 被加入白名单的聊天室成员的用户 ID。

OptionalonAllowListRemoved

  • onAllowListRemoved(params): void

  • 有成员被移出聊天室白名单的回调。

    Parameters

    • params: {
          members: string[];
          roomId: string;
      }
      • members: string[]
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [members] 被移出聊天室白名单列表的成员的用户 ID。

OptionalonAnnouncementChanged

  • onAnnouncementChanged(params): void

  • 聊天室公告更新回调。

    Parameters

    • params: {
          announcement: string;
          roomId: string;
      }
      • announcement: string
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [announcement] 更新后的聊天室公告。

OptionalonAttributesRemoved

  • onAttributesRemoved(params): void

  • 聊天室自定义属性（key-value）移除回调。聊天室所有成员会收到该事件。

    Parameters

    • params: {
          from: string;
          removedKeys: string[];
          roomId: string;
      }
      • from: string
      • removedKeys: string[]
      • roomId: string

    Returns void

    Params

    参数组。

    • roomId：聊天室 ID。
    • removedKeys: 移除的聊天室自定义属性的属性 key 列表。
    • from: 操作者的用户 ID。

OptionalonAttributesUpdated

  • onAttributesUpdated(params): void

  • 聊天室自定义属性（key-value）更新回调。聊天室所有成员会收到该事件。

    Parameters

    • params: {
          attributes: Map<string, string>;
          from: string;
          roomId: string;
      }
      • attributes: Map<string, string>
      • from: string
      • roomId: string

    Returns void

    Params

    参数组。

    • roomId 聊天室 ID。
    • attributes 更新的聊天室自定义属性列表。
    • from 操作者的用户 ID。

OptionalonDestroyed

  • onDestroyed(params): void

  • 聊天室解散的回调。

    Parameters

    • params: {
          roomId: string;
          roomName?: string;
      }
      • roomId: string
      • OptionalroomName?: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [roomName] 聊天室名称。

OptionalonMemberExited

  • onMemberExited(params): void

  • 聊天室成员主动退出回调。

    Parameters

    • params: {
          participant: string;
          roomId: string;
          roomName?: string;
      }
      • participant: string
      • roomId: string
      • OptionalroomName?: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [participant] 离开聊天室的用户 ID。

OptionalonMemberJoined

  • onMemberJoined(params): void

  • 聊天室加入新成员回调。

    Parameters

    • params: {
          ext?: string;
          participant: string;
          roomId: string;
      }
      • Optionalext?: string
      • participant: string
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [participant] 新成员用户 ID。

OptionalonMemberRemoved

  • onMemberRemoved(params): void

  • 聊天室成员被移除回调。

    Parameters

    • params: {
          participant?: string;
          reason?: string;
          roomId: string;
          roomName?: string;
      }
      • Optionalparticipant?: string
      • Optionalreason?: string
      • roomId: string
      • OptionalroomName?: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [roomName] 聊天室名称。
    • Param [participant] 被移出聊天室的用户 ID。
    • Param [reason] 移除的原因。

OptionalonMuteListAdded

  • onMuteListAdded(params): void

  • 有成员被禁言回调。

    Parameters

    • params: {
          expireTime?: string;
          mutes: string[];
          roomId: string;
      }
      • OptionalexpireTime?: string
      • mutes: string[]
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [mutes] 被禁言成员的用户 ID。
    • Param [expireTime] 预留参数，禁言过期时间戳。

OptionalonMuteListRemoved

  • onMuteListRemoved(params): void

  • 有成员从禁言列表中移除回调。

    Parameters

    • params: {
          mutes: string[];
          roomId: string;
      }
      • mutes: string[]
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [mutes] 被移出禁言列表的用户 ID 列表。

OptionalonOwnerChanged

  • onOwnerChanged(params): void

  • 转移聊天室的所有权的回调。

    Parameters

    • params: {
          newOwner: string;
          oldOwner: string;
          roomId: string;
      }
      • newOwner: string
      • oldOwner: string
      • roomId: string

    Returns void

    Params

    参数组。

    • Param [roomId] 聊天室 ID。
    • Param [newOwner] 新聊天室所有者的用户 ID。
    • Param [oldOwner] 原来的聊天室所有者的用户 ID。

OptionalonSpecificationChanged

  • onSpecificationChanged(room): void

  • 聊天室详情变更回调。聊天室所有成员会收到该事件。

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Methods