Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Chatroom

Implements

Index

Constructors

Methods

  • audioToMp3(_options: { url: string }): string
  • audioToText(_options: { url: string; done: any }): void
  • 音频转文字。注意,该功能仅在 NIM 中可以使用。Chatroom尚未实现此功能。

    • 仅支持通过previewFile或者sendFile拿到的音频 url, 或者收到的音频消息的 url

    Parameters

    Returns void

  • blurImage(_options: { radius: number; sigma: number; url: string; done?: any }): void
  • 高斯模糊图片

    • 只支持通过预览文件或发送文件消息拿到的图片 url, 或者经过其他图片操作后拿到的图片 url

    Parameters

    • _options: { radius: number; sigma: number; url: string; done?: any }
      • radius: number

        高斯模糊半径

      • sigma: number

        高斯模糊标准差,不能小于 0

      • url: string

        NOS 图片源链接

      • done?:function

    Returns void

  • closeChatroom(_options: { custom?: string; done?: any }): void
  • connect(): void
  • 使用 disconnect 方法登出IM后,可以调用 connect 重新登录。调用 getInstance 后会自动建立长连接,无需调用 connect。

    关联函数

    示例

    chatroom.disconnect({
    done: function() {
    chatroom.connect()
    }
    })

    Returns void

  • cropImage(_options: { height: number; url: string; width: number; x: number; y: number; done?: any }): void
  • 剪裁图片

    • 只支持通过预览文件或发送文件消息拿到的图片 url, 或者经过其他图片操作后拿到的图片 url
    • 从坐标 (x, y) 处截取尺寸为 width*height 的图片, (0, 0) 代表左上角
    • width/height 不能小于0, 如果 width/height 大于图片的原始宽度/高度, 那么将被替换为图片的原始宽度/高度

    Parameters

    • _options: { height: number; url: string; width: number; x: number; y: number; done?: any }
      • height: number

        高度

      • url: string

        NOS 图片源链接

      • width: number

        宽度

      • x: number

        x 坐标, 必须需为整数

      • y: number

        y 坐标, 必须需为整数

      • done?:function

    Returns void

  • deleteNosAccessToken(_options: { token: string; done: any }): void
  • destroy(__options: { done: any }): void
  • disconnect(__options: { done: any }): void
  • getChatroom(_options: { done?: any }): void
  • getChatroomMemberCountByTag(_options: { tag: string; done: any }): void
  • getChatroomMembers(_options: { guest: boolean; limit?: number; onlyOnline?: boolean; time?: number; done: any }): void
  • getChatroomMembersByTag(_options: { limit?: number; tag: string; time?: number; done: any }): void
  • getChatroomMembersInfo(_options: { accounts: string[]; done: any }): void
  • getHistoryMsgs(_options: { limit?: number; msgTypes?: string[]; reverse?: boolean; timetag?: number; done: any }): void
  • 获取聊天室历史消息。

    • 返回消息的有效数量小于等于 limit。为了方便会话中生成时间戳,在返回结果中插入了若干条时间戳数据。因此返回消息总长度可能大于 limit
    • reverse 为 false 时,返回消息时间 < timetag
    • reverse 为 true 时,返回消息时间 > timetag
    • reverse 为 false 时,返回消息按照时间降序排列,即越早的消息越靠后
    • reverse 为 true 时,返回消息按照时间升序排列,即越晚的消息越靠后
    • 分页查询时,由于跨分页时查询结果有重复,推荐开发者根据 idClient 去重

    Parameters

    • _options: { limit?: number; msgTypes?: string[]; reverse?: boolean; timetag?: number; done: any }
      • Optional limit?: number

        limit, 默认 100

      • Optional msgTypes?: string[]

        消息类型列表,默认全部消息类型

      • Optional reverse?: boolean
        • 取 false 时,返回消息时间 < timetag。返回的队列按照时间降序排列
        • 取 true 时,返回消息时间 > timetag。返回的队列按照时间生序排列
      • Optional timetag?: number

        毫秒级时间戳。若不填写,或者填写的值为 0,其数值会受 reverse影响

        • reverse 为 false 时, timetag 默认值为当前服务器时间
        • reverse 为 true 时, timetag 默认值为 0
      • done:function

    Returns void

  • getHistoryMsgsByTags(_options: { fromTime?: number; limit?: number; reverse?: 0 | 1; tags: string[]; toTime?: number; types: string[]; done: any }): void
  • 根据标签获取聊天室历史消息。

    • 返回消息的数量小于等于 limit
    • reverse 为 0 时,从 fromTime 开始,寻找 time >= fromTime && time <= toTime 的消息
    • reverse 为 1 时,从 toTime 开始, 寻找 time >= fromTime && time <= toTime 的消息
    • reverse 为 0 时,返回消息按照时间升序排列,即越晚的消息越靠后
    • reverse 为 1 时,返回消息按照时间降序排列,即越早的消息越靠后
    • 分页查询时,由于跨分页时查询结果有重复,推荐开发者根据 idClient 去重

    注意

    • 若设置了 fromTime,则必须设置 toTime 大于 fromTime,否则会报参数异常
    • fromTime 默认为 0,toTime 默认为服务器当前时间

    Parameters

    • _options: { fromTime?: number; limit?: number; reverse?: 0 | 1; tags: string[]; toTime?: number; types: string[]; done: any }
      • Optional fromTime?: number

        开始时间

      • Optional limit?: number

        数量限制,默认 100

      • Optional reverse?: 0 | 1

        默认为 0。

        • 0 表示从 fromTime 开始向后查找。同时返回的结果按照时间升序排列。
        • 1 表示从 toTime 开始向前查找。同时返回的结果按照时间降序排列。
      • tags: string[]

        标签 ['tag1', 'tag2', 'tag3']

      • Optional toTime?: number

        结束时间

      • types: string[]

        消息类型

      • done:function

    Returns void

  • getNosAccessToken(_options: { ext?: string; url: string; userAgent?: string; done: any }): void
  • 获取文件的短链接的鉴权 token

    • 在上传文件时,若设置参数nosScenes为nim_security_开头的字符串,则需要调用该接口获取token后才能下载文件。nosScenes可在初始化时全局配置,也可在发送、预览某文件时单独设置
    • 下载文件后请及时 CloudStorageInterface.deleteNosAccessToken,避免token泄漏

    Parameters

    • _options: { ext?: string; url: string; userAgent?: string; done: any }
      • Optional ext?: string
      • url: string

        文件 url

      • Optional userAgent?: string
      • done:function
        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { resUrl: string; token: string }
            • resUrl: string

              完整可访问的链接

            • token: string

          Returns void

    Returns void

  • getNosOriginUrl(_options: { safeShortUrl: string; done: any }): void
  • interlaceImage(_options: { url: string; done?: any }): void
  • interlace 图片

    • 只支持通过预览文件或发送文件消息拿到的图片 url, 或者经过其他图片操作后拿到的图片 url
    • 在网络环境较差时, interlace 后的图片会以从模糊到清晰的方式呈现给用户

    Parameters

    Returns void

  • kickChatroomMember(_options: { account: string; custom: string; done?: any }): void
  • logout(): void
  • 退出登录。

    注:SDK 版本 v9.6.0 以下推荐先调用 logout 再调用 disconnect/destroy 来保证退出。v9.6.0 及以上不需要调用这个 API,disconnect/destroy 断开前会自动调用。

    Returns void

  • markChatroomBlacklist(_options: { account: string; custom?: string; isAdd: boolean; done: any }): void
  • 设置聊天室黑名单

    • 被拉黑后,所有聊天室成员会收到类型为 attach.type === 'blackMember' 的聊天室通知消息。
    • 解除拉黑后,所有聊天室成员会收到类型为 attach.type === 'unblackMember' 的聊天室通知消息。
    • 黑名单用户收到 ondisconnect 回调,回调的 code = ‘kicked', reason = 'blacked'
    • 黑名单用户无法进入聊天室

    Parameters

    • _options: { account: string; custom?: string; isAdd: boolean; done: any }
      • account: string

        待设置的账号

      • Optional custom?: string

        扩展字段, 如果填了, 那么其它聊天室成员收到的 聊天室通知消息 的attach.custom的值为此字段

      • isAdd: boolean

        true表示添加, false表示移除

      • done:function

    Returns void

  • markChatroomCommonMember(_options: { account: string; custom?: string; isAdd: boolean; level?: number; done: any }): void
  • markChatroomGaglist(_options: { account: string; custom?: string; isAdd: boolean; done: any }): void
  • 设置聊天室禁言名单

    • 被禁言后,所有聊天室成员会收到类型为 attach.type === 'gagMember' 的聊天室通知消息。
    • 解除禁言后,所有聊天室成员会收到类型为 attach.type === 'ungagMember' 的聊天室通知消息。
    • 禁言名单用户无法发送消息

    关联函数

    Parameters

    • _options: { account: string; custom?: string; isAdd: boolean; done: any }
      • account: string

        待设置的账号

      • Optional custom?: string

        扩展字段, 如果填了, 那么其它聊天室成员收到的 聊天室通知消息 的attach.custom的值为此字段

      • isAdd: boolean

        true表示添加, false表示移除

      • done:function

    Returns void

  • markChatroomIdentity(_options: { account: string; custom?: string; identity: string; isAdd: boolean; done: any }): void
  • markChatroomManager(_options: { account: string; custom?: string; isAdd: boolean; done: any }): void
  • packFileDownloadName(_options: { name: string; url: string }): string
  • peak(_options: { done: any }): void
  • 获取聊天室队列中第一个元素。返回数据在回调函数的第三个参数中

    Parameters

    • _options: { done: any }
      • done:function
        • done(err: null | Error, data: object, Obj: { elementKey: string; elementValue: string }): void
        • Parameters

          • err: null | Error
          • data: object
          • Obj: { elementKey: string; elementValue: string }
            • elementKey: string

              元素的UniqKey,长度限制128字节

            • elementValue: string

              元素内容,长度限制4096字节

          Returns void

    Returns void

  • 上传并且预览文件。开发者在拿到文件对象之后, 可以调用发送文件消息来发送文件消息。

    注意一

    • fileInput、file、blob、filePath四个参数选择一个传入
    • fileInput: type='file'类型的input DOM元素的id。上传完成前请不要操作此节点上的文件
    • file: previewFile 回调函数的参数
    • blob: Blob类型JS对象
    • filePath: RN,小程序等特殊的 JS 运行环境专用(chooseImage 拿到的该临时路径)

    注意二

    • type: image、audio、video 或 file。默认为 file。主要区别在于消息体中 file 对象含有的信息不同
    • image: url, name, size, ext, w, h, type
    • audio: url, name, size, ext, container, dur
    • video: url, name, size, ext, container, dur, w, h
    • file: url, name, size, ext

    注意三

    • 文件大小限制为最大 100M
    • 高级浏览器会在上传前就检测文件大小
    • IE8/IE9 会在上传完成后检测文件大小

    Parameters

    Returns void

  • processImage(_options: { ops: NIMStrAnyObj; url: string; done?: any }): void
  • 处理图片

    此方法接收一组图片操作, 按操作顺序依次处理图片, 可选的操作包括:

    • 修改图片质量
    • interlace 图片
    • 旋转图片
    • 高斯模糊图片
    • 裁剪图片
    • 生成缩略图
    • 预览文件
    • 发送文件消息

    每个操作所需的参数请参考上面的各个方法, 除了上面方法列出来的参数之外, 每个操作需要提供操作类型, 分别是

    • 'quality'
    • 'interlace'
    • 'rotate'
    • 'blur'
    • 'crop'
    • 'thumbnail'

    示例代码

    // 裁剪后旋转
    var url = 'http://nim.nos.netease.com/MTAxMTAwMg==/bmltYV8xNDc5OTNfMTQ0MzE0NTgyNDI0M184YjFkYTMwMS02NjcxLTRiYjktYTUwZC04ZTVlZjZlNzZjMzA=';
    nim.processImage({
    url: url,
    ops: [
    {
    type: 'crop',
    x: 100,
    y: 0,
    width: 250,
    height: 250,
    },
    {
    type: 'thumbnail',
    mode: 'cover',
    width: 80,
    height: 80
    }
    ],
    done: processImageDone
    });
    function processImageDone(error, obj) {
    console.log('处理图片' + (!error?'成功':'失败'), error, obj);
    }

    Parameters

    • _options: { ops: NIMStrAnyObj; url: string; done?: any }
      • ops: NIMStrAnyObj

        操作序列. 按操作顺序依次处理图片, 具体格式参照前面几个和 image 相关的处理接口

        类似这样的效果

        [ { type: 'crop', x: 100, y: 0, width: 250, height: 250, }, { type: 'thumbnail', mode: 'cover', width: 80, height: 80 } ]

      • url: string
      • done?:function

    Returns void

  • qualityImage(_options: { quality: number; url: string; done?: any }): void
  • 修改图片质量

    • 只支持通过预览文件或发送文件消息拿到的图片 url, 或者经过其他图片操作后拿到的图片 url
    • 默认图片质量为100, 开发者可以降低图片质量来省流量

    Parameters

    • _options: { quality: number; url: string; done?: any }
      • quality: number

        图片质量, 必须为整数, 取值范围为 0-100

      • url: string

        NOS 图片源链接

      • done?:function

    Returns void

  • queueChange(_options: { elementMap: {}; needNotify?: boolean; notifyExt?: string; done?: any }): void
  • 批量更新聊天室队列。若 needNotify 为 true,所有在线用户收到如下通知消息。如果 needNotify 为 false,则无用户收到更新

    • attach.type === 'updateQueue'
    • attach.queueChange.type === 'BATCH_UPDATE'
    • attach.custom 为 notifyExt

    Parameters

    • _options: { elementMap: {}; needNotify?: boolean; notifyExt?: string; done?: any }
      • elementMap: {}

        批量更新元素的key-value对,key/value分别是elementKey和elementValue(elementKey限制128字节,elementValue限制4096字节),一次最多更新100个

        • [key: string]: string
      • Optional needNotify?: boolean

        是否需要发送广播通知,可选参数,不传默认false,当设置为 true 时,所有聊天室成员会收到类型为 'updateQueue' 聊天室通知消息。

      • Optional notifyExt?: string

        通知中的自定义字段,长度限制2048

      • done?:function
        • done(err: null | Error, data: NIMStrAnyObj, Obj: { elementKeyArray: string[] }): void
        • 结果回调函数

          Parameters

          • err: null | Error
          • data: NIMStrAnyObj
          • Obj: { elementKeyArray: string[] }
            • elementKeyArray: string[]

          Returns void

    Returns void

  • queueDrop(_options: { done: any }): void
  • queueList(_options: { done: any }): void
  • 获取聊天室队列列表

    Parameters

    • _options: { done: any }
      • done:function
        • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { queueList: { elementKey: string; elementValue: string }[] }): void
        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { queueList: { elementKey: string; elementValue: string }[] }
            • queueList: { elementKey: string; elementValue: string }[]

          Returns void

    Returns void

  • queueOffer(_options: { elementAccount?: string; elementKey: string; elementValue: string; transient?: boolean; done?: any }): void
  • 新加(更新)队列元素。如果elementKey已存在,更新元素,否则在队尾插入新元素。操作后,所有在线用户收到如下通知消息:

    • attach.type === 'updateQueue'
    • attach.queueChange.type === 'OFFER'

    Parameters

    • _options: { elementAccount?: string; elementKey: string; elementValue: string; transient?: boolean; done?: any }
      • Optional elementAccount?: string

        可选参数,队列元素所属账号,默认不传表示队列元素属于当前操作人,管理员可以指定队列元素归属于其他合法账号

      • elementKey: string

        新元素的UniqKey,长度限制128字节

      • elementValue: string

        新元素内容,长度限制4096字节

      • Optional transient?: boolean

        可选参数,不传默认false,当提交这个新元素的用户从聊天室掉线或退出的时候,是否需要删除这个元素。

      • done?:function

    Returns void

  • queuePoll(_options: { elementKey?: string; done: any }): void
  • 删除队列元素。操作后,所有在线用户收到如下通知消息:

    • attach.type === 'updateQueue'
    • attach.queueChange.type === 'POLL'

    Parameters

    • _options: { elementKey?: string; done: any }
      • Optional elementKey?: string

        需要取出的元素的UniqKey, 传空传表示取出第一个元素

      • done:function
        • done(err: null | Error, data: { elementKey?: string }, Obj: { elementKey: string; elementValue: string }): void
        • 结果回调函数

          Parameters

          • err: null | Error
          • data: { elementKey?: string }
            • Optional elementKey?: string
          • Obj: { elementKey: string; elementValue: string }
            • elementKey: string

              元素的UniqKey,长度限制128字节

            • elementValue: string

              元素内容,长度限制4096字节

          Returns void

    Returns void

  • rotateImage(_options: { angle: number; url: string; done?: any }): void
  • 旋转图片

    • 只支持通过预览文件或发送文件消息拿到的图片 url, 或者经过其他图片操作后拿到的图片 url

    Parameters

    • _options: { angle: number; url: string; done?: any }

    Returns void

  • 描述

    当 SDK 提供的能力无法满足您的业务需求时,调用该 API 进行个性化定制发送,例如石头剪刀布和投骰子功能。

    注意

    该接口直接返回的是 sending 状态的未完成消息体,发送完毕的消息体需要传递 options.done 获得。

    影响范围

    调用该 API 可触发:

    1. 接收方的 NIMChatroomGetInstanceOptions.onmsgs 回调函数
    2. 发送方同时在线的其它客户端 NIMChatroomGetInstanceOptions.onmsgs 回调

    示例

    chatroom.sendCustomMsg({
    //接收方通过onmsgs接收消息
    //然后如果msg.type === 'custom',接收方通过读取msg.content,然后调用业务代码
    content: JSON.stringify({type: 1}),
    done: function(err, msg) {
    if (err) {
    console.log('发送失败', err)
    } else {
    console.log('发送消息成功,消息为: ', msg)
    }
    }
    })

    Parameters

    Returns NIMChatroomMessage

  • 描述

    发送图片、视频、音频或其他文件。用户可以选择调用 sendFile 上传并发送文件。 也可以选择先调用 previewFile 上传文件,再调用 sendFile 发送文件

    注意一

    • 该接口直接返回的是 sending 状态的未完成消息体,发送完毕的消息体需要传递 options.done 获得。

    注意二

    • fileInput、file、blob、filePath四个参数选择一个传入
    • fileInput: type='file'类型的input DOM元素的id。上传完成前请不要操作此节点上的文件
    • file: previewFile 回调函数的参数
    • blob: Blob类型JS对象
    • filePath: RN,小程序等特殊的 JS 运行环境专用(chooseImage 拿到的该临时路径)

    注意三

    • type: image、audio、video 或 file。默认为 file。主要区别在于消息体中 file 对象含有的信息不同
    • image: url, name, size, ext, w, h, type
    • audio: url, name, size, ext, container, dur
    • video: url, name, size, ext, container, dur, w, h
    • file: url, name, size, ext

    影响范围

    调用该 API 可触发:

    1. 接收方的 NIMChatroomGetInstanceOptions.onmsgs 回调函数
    2. 发送方同时在线的其它客户端 NIMChatroomGetInstanceOptions.onmsgs 回调

    直接发送文件

    chatroom.sendFile({
    type: 'image',
    fileInput: 'domId',
    done: function(err, msg) {
    if (err) {
    console.log('发送失败', err)
    } else {
    console.log('发送消息成功,消息为: ', msg)
    }
    }
    })

    先previewFile,再发送文件

    chatroom.previewFile({
    type: 'image',
    fileInput: fileInput,
    uploadprogress: function(obj) {
    console.log('文件总大小: ' + obj.total + 'bytes');
    console.log('已经上传的大小: ' + obj.loaded + 'bytes');
    console.log('上传进度: ' + obj.percentage);
    console.log('上传进度文本: ' + obj.percentageText);
    },
    done: function(error, file) {
    console.log('上传image' + (!error?'成功':'失败'));
    // show file to the user
    if (!error) {
    var msg = chatroom.sendFile({
    file: file,
    done: sendMsgDone
    });
    console.log('正在发送image消息, id=' + msg.idClient);
    pushMsg(msg);
    }
    }
    })

    重发文件

      let message = chatrooom.sendFile({
    type: 'image',
    fileInput: 'domId',
    done: function(err, obj) {
    if (err) {
    console.log('发送失败', err)
    // 重发. 当上传文件失败时 obj 参数的 msg 附带消息体,其他情况的 obj 就是消息体。
    setTimeout(function () {
    resendMessage(obj.msg ? obj.msg : obj)
    }, 3000)
    } else {
    console.log('发送消息成功,消息为: ', obj)
    }
    }
    })

    // 上传前已经能得到 idClient 做渲染
    console.log(message.idClient)

    // 重发
    function resendMessage(oldMessage) {
    nim.sendFile(Object.assign(oldMessage, {
    type: 'image',
    fileInput: 'domId',
    resend: true, // 注意这个 resend 标记为 true,才能固定使用 oldMessage 里的 idClient
    done: function(err, obj) {
    if (err) {
    console.log('发送失败', err)
    } else {
    console.log('发送消息成功,消息为: ', obj)
    }
    }
    }))
    }

    关联链接

    Parameters

    Returns NIMChatroomMessage

  • 描述

    发送地理位置消息

    注意

    该接口直接返回的是 sending 状态的未完成消息体,发送完毕的消息体需要传递 options.done 获得。

    影响范围

    调用该 API 可触发:

    1. 接收方的 NIMChatroomGetInstanceOptions.onmsgs 回调函数
    2. 发送方同时在线的其它客户端 NIMChatroomGetInstanceOptions.onmsgs 回调

    示例

    chatroom.sendGeo({
    //接收方通过onMsg接收消息
    //然后如果msg.type === 'geo',接收方通过读取msg.geo,然后调用业务代码
    geo: {
    lng: 116.3833,
    lat: 39.9167,
    title: 'Beijing'
    },
    done: function(err, msg) {
    if (err) {
    console.log('发送失败', err)
    } else {
    console.log('发送消息成功,消息为: ', msg)
    }
    }
    })

    Parameters

    Returns NIMChatroomMessage

  • 描述

    发送提示消息。提示消息主要用于会话内的通知提醒,典型业务场景包括进入群组时出现的欢迎消息和会话过程中命中敏感词后的提示等。

    注意

    该接口直接返回的是 sending 状态的未完成消息体,发送完毕的消息体需要传递 options.done 获得。

    影响范围

    调用该 API 可触发:

    1. 接收方的 NIMChatroomGetInstanceOptions.onmsgs 回调函数
    2. 发送方同时在线的其它客户端 NIMChatroomGetInstanceOptions.onmsgs 回调

    示例

    chatroom.sendTipMsg({
    //接收方通过onMsg接收消息
    //然后如果msg.type === 'tip',接收方通过读取msg.tip,然后调用业务代码
    tip: 'tip content',
    done: function(err, msg) {
    if (err) {
    console.log('发送失败', err)
    } else {
    console.log('发送消息成功,消息为: ', msg)
    }
    }
    })

    Parameters

    Returns NIMChatroomMessage

  • stripImageMeta(_options: { url: string; done: any }): string
  • 去除图片元信息

    • 只支持通过预览文件或发送文件消息拿到的图片 url, 或者经过其他图片操作后拿到的图片 url
    • 去除元信息后的图片将不包含 EXIF 信息

    Parameters

    Returns string

  • thumbnailImage(_options: { axis: { x: number; y: number }; height?: number; url: string; width?: number; done?: any }): void
  • 生成图片的略缩图

    • 只支持通过预览文件或发送文件消息拿到的图片 url, 或者经过其他图片操作后拿到的图片 url
    • width/height 限制了缩略图的尺寸。width/height 必须大于等于 0, 不能同时为 0, 必须小于 4096
    • 不同模式下生成的缩略图是不一样的, 目前支持以下三种模式:
      • 'cover': 原图片等比缩略, 缩略图一边等于请求的尺寸, 另一边大于请求的尺寸, 即缩略图刚好能覆盖住尺寸为 width*height 的矩形
      • 'contain': 原图片等比缩略, 缩略图一边等于请求的尺寸, 另一边小于请求的尺寸, 即尺寸为 width*height 的矩形刚好能覆盖住缩略图
      • 'crop': 先等比缩略原图片, 使得一边等于请求的尺寸, 另一边大于请求的尺寸, 然后对大于请求尺寸的那条边进行裁剪, 使得最终的图片大小刚好等于请求的尺寸
    • 如果缩略图尺寸大于图片尺寸, 默认情况下图片不会被放大, 可以传入参数enlarge=true来放大图片
    • 'crop' 模式下可以传入参数 axis.x 或 axis.y 来控制最后一步裁剪的位置
      • x/y 必须为整数, 取值范围为 0-10, 此方法内部使用 Math.round 来格式化 x/y
      • x 为 0 时表示裁取最左端, x 为 10 时表示裁取最右端
      • y 为 0 时表示裁取最上端, y 为 10 时表示裁取最下端
      • x/y 默认值均为 5, 即裁取正中间

    Parameters

    • _options: { axis: { x: number; y: number }; height?: number; url: string; width?: number; done?: any }
      • axis: { x: number; y: number }

        剪裁坐标

        • x: number

          x 坐标, 必须需为整数

        • y: number

          y 坐标, 必须需为整数

      • Optional height?: number

        缩略图的高度

      • url: string

        NOS 图片源链接

      • Optional width?: number

        缩略图的宽度

      • done?:function

    Returns void

  • updateChatroom(_options: { antiSpamBusinessId?: string; chatroom: { announcement?: string; broadcastUrl?: string; custom?: string; name?: string; queuelevel?: string }; custom?: string; needNotify: boolean; done?: any }): void
  • 更新聊天室的信息。对应的服务器接口为:

    Parameters

    • _options: { antiSpamBusinessId?: string; chatroom: { announcement?: string; broadcastUrl?: string; custom?: string; name?: string; queuelevel?: string }; custom?: string; needNotify: boolean; done?: any }
      • Optional antiSpamBusinessId?: string

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

      • chatroom: { announcement?: string; broadcastUrl?: string; custom?: string; name?: string; queuelevel?: string }

        待更新的聊天室信息

        • Optional announcement?: string

          聊天室公告

        • Optional broadcastUrl?: string

          直播地址

        • Optional custom?: string

          扩展字段

        • Optional name?: string

          聊天室名字

        • Optional queuelevel?: string

          队列管理权限:0:所有人都有权限变更队列,1:只有主播管理员才能操作变更

      • Optional custom?: string

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

      • needNotify: boolean

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

      • done?:function

    Returns void

  • updateChatroomMemberTempMute(_options: { account: string; custom?: string; duration: number; needNotify: boolean; done?: any }): void
  • updateTagMembersTempMute(_options: { custom?: string; duration: number; needNotify: boolean; notifyTargetTags?: string; tag: string; done?: any }): void
  • updateTags(_options: { ext?: string; needNotify?: true; notifyTargetTags?: string; tags?: string[]; done?: any }): void
  • 更新当前长连接对应的标签。若调用服务器接口更新 tags,则会更新指定用户当前所有长连接的标签组

    Parameters

    • _options: { ext?: string; needNotify?: true; notifyTargetTags?: string; tags?: string[]; done?: any }
      • Optional ext?: string

        通知的扩展字段,推荐 JSON 格式字符串构建

      • Optional needNotify?: true

        此更新是否需要通知,默认 false。通知的范围由 notifyTargetTags(注意 notifyTargetTags 可以由聊天室初始化设置)

      • Optional notifyTargetTags?: string

        通知标签。是一个标签表达式,用于通知符合规则标签的聊天室成员,例如成员上下线,更新标签的通知。不填或空字符串代表允许通知所有聊天室成员

      • Optional tags?: string[]

        标签。可以设置多个,覆盖式更新,例子:["tag1", "tag2"];如果要删除,不传即可;若传空数组 就表示用户使用了标签功能,但是不属于任何标签。

      • done?:function

    Returns void