Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UserInterface

Hierarchy

  • UserInterface

Implemented by

Index

Methods

Methods

addToBlacklist

  • addToBlacklist(options: { account: string; done?: any }): void

  • 加入黑名单。调用后，初始化同步阶段收到 onblacklist 回调，多端同步阶段收到 onsyncmarkinblacklist 回调

    示例场景

    示例

    nim.addToBlacklist({
      account: 'user1',
      done: function(err, data) {
        if (err) {
          console.log('加入黑名单失败', err)
        } else {
          console.log('加入黑名单成功', data.account)
        }
      }
    })

    Parameters

    • options: { account: string; done?: any }
      • account: string
      • done?:function
        • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { account: string; isAdd: boolean; record: { account: string; updateTime: number } }): void

        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { account: string; isAdd: boolean; record: { account: string; updateTime: number } }
            • account: string

              被操作者账号 ID

            • isAdd: boolean

              是否加入名单(黑名单或者静音列表)

              true 代表某人被加入名单，false 代表某人被移出名单

            • record: { account: string; updateTime: number }

              该操作记录的详情

              • account: string

                被操作者账号 ID

              • updateTime: number

                更新时间戳

          Returns void

    Returns void

addToMutelist

  • addToMutelist(options: { account: string; done?: any }): void

  • 加入静音列表。调用后，初始化同步阶段收到 onmutelist 回调，多端同步阶段收到 onsyncmarkinmutelist 回调

    • 通过设置静音列表来控制单聊免打扰
    • 被静音用户发送的消息，不会通过推送通知给用户
    • 用户 UI 层，可以通过静音列表来决定是否渲染会话的未读数

    示例场景

    示例

    nim.addToMutelist({
      account: 'user1',
      done: function(err, data) {
        if (err) {
          console.log('加入静音列表失败', err)
        } else {
          console.log('加入静音列表成功', data.account)
        }
      }
    })

    Parameters

    • options: { account: string; done?: any }
      • account: string
      • done?:function
        • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { account: string; isAdd: boolean; record: { account: string; updateTime: number } }): void

        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { account: string; isAdd: boolean; record: { account: string; updateTime: number } }
            • account: string

              被操作者账号 ID

            • isAdd: boolean

              是否加入名单(黑名单或者静音列表)

              true 代表某人被加入名单，false 代表某人被移出名单

            • record: { account: string; updateTime: number }

              该操作记录的详情

              • account: string

                被操作者账号 ID

              • updateTime: number

                更新时间戳

          Returns void

    Returns void

getRelations

  • getRelations(options: { done?: any }): void

  • 获取黑名单和静音列表。如果开发者在初始化SDK的时候设置了syncRelations为false, 那么就收不到onblacklist和onmutelist回调, 可以调用此接口来获取黑名单和静音列表。

    示例

    nim.getRelations({
      done: function(err, data) {
        if (err) {
          console.log('获取黑名单和静音列表失败', err)
        } else {
          console.log('黑名单', data.blacklist)
          console.log('静音列表', data.mutelist)
        }
      }
    })

    Parameters

    • options: { done?: any }
      • done?:function
        • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { blacklist: { account: string; createTime: number; isBlack?: boolean; isMuted?: boolean; updateTime: number }[]; mutelist: { account: string; createTime: number; isBlack?: boolean; isMuted?: boolean; updateTime: number }[] }): void

        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { blacklist: { account: string; createTime: number; isBlack?: boolean; isMuted?: boolean; updateTime: number }[]; mutelist: { account: string; createTime: number; isBlack?: boolean; isMuted?: boolean; updateTime: number }[] }
            • blacklist: { account: string; createTime: number; isBlack?: boolean; isMuted?: boolean; updateTime: number }[]
              • account: IM account
              • isMuted: 是否被静音
              • isBlack: 是否被拉入黑名单
            • mutelist: { account: string; createTime: number; isBlack?: boolean; isMuted?: boolean; updateTime: number }[]
              • account: IM account
              • isMuted: 是否被静音
              • isBlack: 是否被拉入黑名单

          Returns void

    Returns void

getUser

  • getUser(options: { account: string; sync?: boolean; done?: any }): void

  • 获取用户名片

    示例场景

    示例

    nim.getUser({
      account: 'user1',
      sync: false,
      done: function(err, user) {
        if (err) {
          console.log('获取用户名片失败', err)
        } else {
          console.log('获取用户名片成功', user)
        }
      }
    })

    Parameters

    • options: { account: string; sync?: boolean; done?: any }

    Returns void

getUsers

  • getUsers(options: { accounts: string[]; sync?: boolean; done?: any }): void

  • 获取一批用户的名片, 每次最多 150 个.

    示例

    nim.getUsers({
      accounts: ['user1', 'user2', 'user3'],
      sync: true,
      done: function(err, users) {
        if (err) {
          console.log('批量获取用户名片失败', err)
        } else {
          console.log('批量获取用户名片成功', users)
        }
      }
    })

    Parameters

    • options: { accounts: string[]; sync?: boolean; done?: any }

    Returns void

getUsersFromDB

  • getUsersFromDB(options: { accountIds?: string[]; done?: any }): void

isUserInBlackList

  • isUserInBlackList(options: { account: string; done?: any }): void

  • 查看某人是否在当前用户在黑名单里

    注：该接口需要数据库支持，若没有开启本地数据库能力，done 回调里只会返回 false

    示例

    nim.isUserInBlackList({
      account: 'user1',
      done: function(err, isInBlacklist) {
        if (err) {
          console.log('查询黑名单状态失败', err)
        } else {
          console.log('用户是否在黑名单中:', isInBlacklist)
        }
      }
    })

    Parameters

    Returns void

markInBlacklist

markInMutelist

removeFromBlacklist

  • removeFromBlacklist(options: { account: string; done?: any }): void

  • 移出黑名单。调用后，初始化同步阶段收到 onblacklist 回调，多端同步阶段收到 onsyncmarkinblacklist 回调

    示例场景

    示例

    nim.removeFromBlacklist({
      account: 'user1',
      done: function(err, data) {
        if (err) {
          console.log('移出黑名单失败', err)
        } else {
          console.log('移出黑名单成功', data.account)
        }
      }
    })

    Parameters

    • options: { account: string; done?: any }
      • account: string
      • done?:function
        • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { account: string; isAdd: boolean; record: { account: string; updateTime: number } }): void

        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { account: string; isAdd: boolean; record: { account: string; updateTime: number } }
            • account: string

              被操作者账号 ID

            • isAdd: boolean

              是否加入名单(黑名单或者静音列表)

              true 代表某人被加入名单，false 代表某人被移出名单

            • record: { account: string; updateTime: number }

              该操作记录的详情

              • account: string

                被操作者账号 ID

              • updateTime: number

                更新时间戳

          Returns void

    Returns void

removeFromMutelist

  • removeFromMutelist(options: { account: string; done?: any }): void

  • 移出静音列表。调用后，初始化同步阶段收到 onmutelist 回调，多端同步阶段收到 onsyncmarkinmutelist 回调

    设置静音列表有两个作用：

    1. 开发者根据用户是否在静音列表，决定是否显示未读数等提示UI
    2. 静音列表中用户发送消息，不会触发推送服务

    示例场景

    示例

    nim.removeFromMutelist({
      account: 'user1',
      done: function(err, data) {
        if (err) {
          console.log('移出静音列表失败', err)
        } else {
          console.log('移出静音列表成功', data.account)
        }
      }
    })

    Parameters

    • options: { account: string; done?: any }
      • account: string
      • done?:function
        • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { account: string; isAdd: boolean; record: { account: string; updateTime: number } }): void

        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { account: string; isAdd: boolean; record: { account: string; updateTime: number } }
            • account: string

              被操作者账号 ID

            • isAdd: boolean

              是否加入名单(黑名单或者静音列表)

              true 代表某人被加入名单，false 代表某人被移出名单

            • record: { account: string; updateTime: number }

              该操作记录的详情

              • account: string

                被操作者账号 ID

              • updateTime: number

                更新时间戳

          Returns void

    Returns void

updateMyInfo

  • updateMyInfo(options: { antiSpamBusinessId?: string; avatar?: string; birth?: string; custom?: string; email?: string; gender?: "unknown" | "male" | "female"; nick?: string; sign?: string; tel?: string; done?: any }): void

  • 更新我的名片。调用后，初始化同步阶段收到 onmyinfo 回调，多端同步阶段收到 onupdatemyinfo 回调

    示例场景

    示例

    nim.updateMyInfo({
      nick: '新昵称',
      avatar: 'https://example.com/avatar.png',
      sign: '这是我的签名',
      gender: 'male',
      done: function(err, user) {
        if (err) {
          console.log('更新我的名片失败', err)
        } else {
          console.log('更新我的名片成功', user)
        }
      }
    })

    Parameters

    • options: { antiSpamBusinessId?: string; avatar?: string; birth?: string; custom?: string; email?: string; gender?: "unknown" | "male" | "female"; nick?: string; sign?: string; tel?: string; done?: any }
      • Optional antiSpamBusinessId?: string

        用户配置的对某些资料内容另外的反垃圾的业务 ID

      • Optional avatar?: string

        头像

      • Optional birth?: string

        出生日期

      • Optional custom?: string

        扩展字段

      • Optional email?: string

        邮箱

      • Optional gender?: "unknown" | "male" | "female"

        性别

      • Optional nick?: string

        昵称

      • Optional sign?: string

        签名

      • Optional tel?: string

        电话

      • done?:function

    Returns void