Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ChatroomMemberServiceInterface

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

KickMemberOptions

KickMemberOptions: { account: string; ext?: string }

Type declaration

  • account: string
  • Optional ext?: string

QueryMembersByAccountsOptions

QueryMembersByAccountsOptions: { accounts: string[] }

Type declaration

  • accounts: string[]

    待查询的账号列表, 每次最多20个

QueryMembersByTagOptions

QueryMembersByTagOptions: { limit?: number; tag: string; time?: number }

Type declaration

  • Optional limit?: number

    分页用, 默认 100

  • tag: string

    标签，获取带有这个标签的成员

  • Optional time?: number

    起始时间，分页用；逆序查询该时间之后的成员列表

    第一次不填，默认为0代表当前服务器时间，即获取第一页 第二页及之后，填上一页最后一个成员的enterTime

QueryMembersCountByTagOptions

QueryMembersCountByTagOptions: { tag: string }

Type declaration

  • tag: string

    标签，获取带有这个标签的成员数量

QueryMembersOptions

QueryMembersOptions: { limit?: number; time?: number; type: TChatroomMemberQueryType }

Type declaration

  • Optional limit?: number

    分页用, 默认 100

  • Optional time?: number

    分页用, 查找该时间戳之前的成员

  • type: TChatroomMemberQueryType

SetMemberTempMuteOptions

SetMemberTempMuteOptions: { account: string; duration: number; ext?: string; needNotify?: boolean }

Type declaration

  • account: string

    账号

  • duration: number

    禁言时长，单位秒，传0表示解除禁言

  • Optional ext?: string
  • Optional needNotify?: boolean

    是否需要下发对应的通知消息

SetMembersTempMuteByTagOptions

SetMembersTempMuteByTagOptions: { duration: number; ext?: string; needNotify: boolean; notifyTargetTags?: string; tag: string }

Type declaration

  • duration: number

    禁言时长，单位秒，传0表示解除禁言

  • Optional ext?: string

    对应的通知消息的扩展字段

  • needNotify: boolean

    是否需要下发对应的通知消息

  • Optional notifyTargetTags?: string

    通知消息广播的目标标签，默认是options.tag

  • tag: string

    禁言的tag

TChatroomMemberQueryType

TChatroomMemberQueryType: keyof typeof ChatroomMemberQueryType

UpdateMyRoomRoleOptions

UpdateMyRoomRoleOptions: { ext: string; member: { avatar?: string; ext?: string; nick?: string }; needNotify: boolean; needSave: boolean }

Type declaration

  • ext: string

    扩展字段

  • member: { avatar?: string; ext?: string; nick?: string }
    • Optional avatar?: string

      头像

    • Optional ext?: string

      第三方扩展字段

    • Optional nick?: string

      昵称

  • needNotify: boolean
  • needSave: boolean

    可选，默认false，是否支持 nick, avator 和 ext 字段的持久化，固定成员有效