Chatroom | NIM

Hierarchy

EventEmitter
- Chatroom

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new Chatroom(__options: NIMChatroomGetInstanceOptions): Chatroom

Overrides EventEmitter.constructor
Parameters
- __options: NIMChatroomGetInstanceOptions
Returns Chatroom

Methods

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): Chatroom

Inherited from EventEmitter.addListener
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
Returns Chatroom

audioToMp3

audioToMp3(_options: { url: string }): string

Implementation of CloudStorageInterface.audioToMp3
Parameters
- _options: { url: string }
  - url: string
Returns string

audioToText

audioToText(_options: { done: NIMDefaultDoneFn<string>; url: string }): void

Implementation of CloudStorageInterface.audioToText

音频转文字

注: 入参需要输入 NOS 或者 S3 文件存储对象的原链接，如果你得到的是短链接，使用 API {@link MiscInterface.getNosOriginUrl | getNosOriginUrl} 去转换

Parameters
- _options: { done: NIMDefaultDoneFn<string>; url: string }
  - done: NIMDefaultDoneFn<string>
  - url: string
Returns void

blurImage

blurImage(_options: NIMBlurImageOptions): void

Implementation of CloudStorageInterface.blurImage

旋转图片

// todo 主动转长链处理

Parameters
- _options: NIMBlurImageOptions
Returns void

closeChatroom

closeChatroom(_options: { custom?: string; done?: NIMDefaultDoneFn<void> }): void

Parameters
- _options: { custom?: string; done?: NIMDefaultDoneFn<void> }
  - Optional custom?: string
  - Optional done?: NIMDefaultDoneFn<void>
Returns void

connect

connect(): void

Returns void

cropImage

cropImage(_options: NIMCropImageOptions): void

Implementation of CloudStorageInterface.cropImage

剪裁图片

// todo 主动转长链处理

Parameters
- _options: NIMCropImageOptions
Returns void

deleteNosAccessToken

deleteNosAccessToken(_options: NIMGetNosAccessTokenOptions): void

Implementation of CloudStorageInterface.deleteNosAccessToken
Parameters
- _options: NIMGetNosAccessTokenOptions
Returns void

disconnect

disconnect(): void

Returns void

emit

emit<T>(event: T, ...args: any[]): boolean

Inherited from EventEmitter.emit

Calls each of the listeners registered for a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames

Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]

getChatroom

getChatroom(_options: { done?: NIMDefaultDoneFn<NIMChatRoomInfo> }): void

Parameters
- _options: { done?: NIMDefaultDoneFn<NIMChatRoomInfo> }
  - Optional done?: NIMDefaultDoneFn<NIMChatRoomInfo>
Returns void

getChatroomMembers

getChatroomMembers(_options: NIMChatroomGetChatroomMembersOptions): void

Implementation of NIMChatroomMemberInterface.getChatroomMembers

获取聊天室成员列表

Parameters
- _options: NIMChatroomGetChatroomMembersOptions
Returns void

getChatroomMembersByTag

getChatroomMembersByTag(_options: { done: NIMDefaultDoneFn<{ members: NIMChatroomMember[] }>; tag: string }): void

Implementation of NIMChatroomMemberInterface.getChatroomMembersByTag

获取带有某标签的在线的聊天室成员数量

Parameters
- _options: { done: NIMDefaultDoneFn<{ members: NIMChatroomMember[] }>; tag: string }
  - done: NIMDefaultDoneFn<{ members: NIMChatroomMember[] }>
  - tag: string
Returns void

getChatroomMembersInfo

getChatroomMembersInfo(_options: { accounts: string[]; done: NIMDefaultDoneFn<{ members: NIMChatroomMember[] }> }): void

Implementation of NIMChatroomMemberInterface.getChatroomMembersInfo

获取聊天室成员信息

Parameters
- _options: { accounts: string[]; done: NIMDefaultDoneFn<{ members: NIMChatroomMember[] }> }
  - accounts: string[]
  - done: NIMDefaultDoneFn<{ members: NIMChatroomMember[] }>
Returns void

getFileAuthToken

getFileAuthToken(_options: NIMGetFileAuthTokenOptions): void

Implementation of CloudStorageInterface.getFileAuthToken

获取文件的源链接的鉴权 token

注: 如果开发者传入的是短链接，那么调用 getNosOriginUrl 去得到长链接.

Parameters
- _options: NIMGetFileAuthTokenOptions
Returns void

getHistoryMsgs

getHistoryMsgs(_options: NIMChatroomGetHistoryMsgsOptions): void

Implementation of NIMChatroomMessageInterface.getHistoryMsgs
获取聊天室历史消息
- 获取从 timetag 对应的时间点往前的若干条数据
- 不填 timetag 的话默认为服务器当前时间
Parameters
- _options: NIMChatroomGetHistoryMsgsOptions
Returns void

getHistoryMsgsByTags

getHistoryMsgsByTags(_options: NIMChatroomGetHistoryMsgsByTagsOptions): void

Implementation of NIMChatroomMessageInterface.getHistoryMsgsByTags
根据标签获取聊天室历史消息
- 获取从 fromTime 对应的时间点往前的若干条数据
Parameters
- _options: NIMChatroomGetHistoryMsgsByTagsOptions
Returns void

getNosAccessToken

getNosAccessToken(_options: NIMGetNosAccessTokenOptions): void

Implementation of CloudStorageInterface.getNosAccessToken
Parameters
- _options: NIMGetNosAccessTokenOptions
Returns void

getNosOriginUrl

getNosOriginUrl(_options: { done: NIMDefaultDoneFn<string>; safeShortUrl: string }): void

Implementation of CloudStorageInterface.getNosOriginUrl

短链接转长链接

Parameters
- _options: { done: NIMDefaultDoneFn<string>; safeShortUrl: string }
  - done: NIMDefaultDoneFn<string>
  - safeShortUrl: string
Returns void

interlaceImage

interlaceImage(_options: NIMInterlaceImageOptions): void

Implementation of CloudStorageInterface.interlaceImage

interlace 图片

注: interlace 是修改图片参数让图片从模糊到清晰的方式呈现给用户的方式

// todo 主动转长链处理

Parameters
- _options: NIMInterlaceImageOptions
Returns void

kickChatroomMember

kickChatroomMember(_options: { account: string; done?: NIMDefaultDoneFn<{ account: string }> }): void

Implementation of NIMChatroomMemberInterface.kickChatroomMember

踢聊天室成员

Parameters
- _options: { account: string; done?: NIMDefaultDoneFn<{ account: string }> }
  - account: string
  - Optional done?: NIMDefaultDoneFn<{ account: string }>
Returns void

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount

Return the number of listeners listening to a given event.

Parameters
- event: string | symbol
Returns number

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]

Inherited from EventEmitter.listeners

Return the listeners registered for a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]

markChatroomBlacklist

markChatroomBlacklist(_options: NIMChatroomMemberRoleOptions): void

Implementation of NIMChatroomMemberInterface.markChatroomBlacklist

设置聊天室黑名单

Parameters
- _options: NIMChatroomMemberRoleOptions
Returns void

markChatroomCommonMember

markChatroomCommonMember(_options: NIMChatroomMarkChatroomCommonMemberOptions): void

Implementation of NIMChatroomMemberInterface.markChatroomCommonMember

设置聊天室普通成员

Parameters
- _options: NIMChatroomMarkChatroomCommonMemberOptions
Returns void

markChatroomGaglist

markChatroomGaglist(_options: NIMChatroomMemberRoleOptions): void

Implementation of NIMChatroomMemberInterface.markChatroomGaglist

设置聊天室禁言名单

Parameters
- _options: NIMChatroomMemberRoleOptions
Returns void

markChatroomIdentity

markChatroomIdentity(_options: NIMChatroomMarkChatroomIdentityOptions): void

Implementation of NIMChatroomMemberInterface.markChatroomIdentity

设置聊天室成员身份

Parameters
- _options: NIMChatroomMarkChatroomIdentityOptions
Returns void

markChatroomManager

markChatroomManager(_options: NIMChatroomMemberRoleOptions): void

Implementation of NIMChatroomMemberInterface.markChatroomManager

设置聊天室管理员

Parameters
- _options: NIMChatroomMemberRoleOptions
Returns void

off

off<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): Chatroom

Inherited from EventEmitter.off
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns Chatroom

on

on<T>(event: T, fn: ((...args: any[]) => void), context?: any): Chatroom

Inherited from EventEmitter.on

Add a listener for a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
Returns Chatroom

once

once<T>(event: T, fn: ((...args: any[]) => void), context?: any): Chatroom

Inherited from EventEmitter.once

Add a one-time listener for a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
Returns Chatroom

packFileDownloadName

packFileDownloadName(_options: { name: string; url: string }): string

Implementation of CloudStorageInterface.packFileDownloadName
Parameters
- _options: { name: string; url: string }
  - name: string
  - url: string
Returns string

peak

peak(_options: { done: any }): void

Implementation of NIMChatroomQueueInterface.peak

获取聊天室队列中第一个元素

Parameters
- _options: { done: any }
  - done:function
    - done(err: null | Error, data: {}, Obj: NIMChatroomQueue): void
    - Parameters
      - err: null | Error
      - data: {}
      - Obj: NIMChatroomQueue
      Returns void
Returns void

previewFile

previewFile(_options: NIMPreviewFileOptions): void

Implementation of CloudStorageInterface.previewFile

========================== cloudStorage start =================================

Parameters
- _options: NIMPreviewFileOptions
Returns void

processImage

processImage(_options: NIMProcessImageOptions): void

Implementation of CloudStorageInterface.processImage

处理图片

// todo 主动转长链处理

Parameters
- _options: NIMProcessImageOptions
Returns void

qualityImage

qualityImage(_options: NIMQualityImageOptions): void

Implementation of CloudStorageInterface.qualityImage

修改图片质量

// todo 主动转长链处理

Parameters
- _options: NIMQualityImageOptions
Returns void

queueChange

queueChange(_options: NIMChatroomQueueChangeOptions): void

Implementation of NIMChatroomQueueInterface.queueChange

批量更新聊天室队列

Parameters
- _options: NIMChatroomQueueChangeOptions
Returns void

queueDrop

queueDrop(_options: { done: NIMDefaultDoneFn<void> }): void

Implementation of NIMChatroomQueueInterface.queueDrop

清除聊天室队列

Parameters
- _options: { done: NIMDefaultDoneFn<void> }
  - done: NIMDefaultDoneFn<void>
Returns void

queueList

queueList(_options: { done: NIMDefaultDoneFn<{ queueList: NIMChatroomQueue[] }> }): void

Implementation of NIMChatroomQueueInterface.queueList

获取聊天室队列列表

Parameters
- _options: { done: NIMDefaultDoneFn<{ queueList: NIMChatroomQueue[] }> }
  - done: NIMDefaultDoneFn<{ queueList: NIMChatroomQueue[] }>
Returns void

queueOffer

queueOffer(_options: NIMChatroomQueueInterface): void

Implementation of NIMChatroomQueueInterface.queueOffer

========================== chatroomQueue start =================================

Parameters
- _options: NIMChatroomQueueInterface
Returns void

queuePoll

queuePoll(_options: NIMChatroomQueuePollOptions): void

Implementation of NIMChatroomQueueInterface.queuePoll

删除队列元素

Parameters
- _options: NIMChatroomQueuePollOptions
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): Chatroom

Inherited from EventEmitter.removeAllListeners

Remove all listeners, or those of the specified event.

Parameters
- Optional event: string | symbol
Returns Chatroom

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): Chatroom

Inherited from EventEmitter.removeListener

Remove the listeners of a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns Chatroom

resendMsg

resendMsg(_options: NIMChatroomResendOptions): NIMChatroomMessage

Implementation of NIMChatroomMessageInterface.resendMsg

重发消息

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

Parameters
- _options: NIMChatroomResendOptions
Returns NIMChatroomMessage

rotateImage

rotateImage(_options: NIMRotateImageOptions): void

Implementation of CloudStorageInterface.rotateImage

旋转图片

// todo 主动转长链处理

Parameters
- _options: NIMRotateImageOptions
Returns void

sendCustomMsg

sendCustomMsg(_options: NIMChatroomSendCustomMsgOptions): NIMChatroomMessage

Implementation of NIMChatroomMessageInterface.sendCustomMsg

发送自定义消息

Parameters
- _options: NIMChatroomSendCustomMsgOptions
Returns NIMChatroomMessage

sendFile

sendFile(_options: NIMChatroomSendFileOptions): void | NIMChatroomMessage

Implementation of NIMChatroomMessageInterface.sendFile
发送文件消息
- 开发者可以直接发送文件消息
  - 支持以下几种场景
    
    通过参数fileInput传入文件选择 dom 节点或者节点 ID, SDK 会读取该节点下的文件, 在上传完成前请不要操作该节点下的文件
    
    通过参数blob传入 Blob 对象
    
    通过参数dataURL传入包含 MIME type 和 base64 数据的 data URL, 此用法需要浏览器支持 Blob
  - SDK会先将文件上传到文件服务器, 然后把拿到的文件对象在uploaddone回调中传给用户, 然后将其拼装成文件消息发送出去。
- 开发者也可以先 previewFile|预览文件来获取文件对象, 然后调用此接口发送文件消息。
  - 通过参数file传入文件
- 直接发送文件消息的话会在beforesend回调里面传入SDK生成的idClient, 如果先预览文件再发送, 那么此接口会直接返回idClient
- 参数type指定了要发送的文件类型, 包括图片、音频、视频和普通文件, 对应的值分别为'image'、'audio'、'video'和'file', 不传默认为'file'。
- 图片、音频、视频和普通文件的区别在于具体的文件信息不一样, 具体字段请参考如果提供了参数fileInput, 那么先上传文件到服务器再发送, 不会返回 NIMChatroomMessage , 会在beforesend里面返回 NIMChatroomMessage .
- 如果提供了参数file, 那么直接发送文件消息, 返回 NIMChatroomMessage
Parameters
- _options: NIMChatroomSendFileOptions
Returns void | NIMChatroomMessage

sendGeo

sendGeo(_options: NIMChatroomSendGeoOptions): NIMChatroomMessage

Implementation of NIMChatroomMessageInterface.sendGeo

发送地理位置消息

Parameters
- _options: NIMChatroomSendGeoOptions
Returns NIMChatroomMessage

sendText

sendText(_options: NIMChatroomSendTextOptions): NIMChatroomMessage

Implementation of NIMChatroomMessageInterface.sendText

========================== chatroomMessage start =================================

Parameters
- _options: NIMChatroomSendTextOptions
Returns NIMChatroomMessage

sendTipMsg

sendTipMsg(_options: NIMChatroomSendTipOptions): NIMChatroomMessage

Implementation of NIMChatroomMessageInterface.sendTipMsg

发送 tip 消息

Parameters
- _options: NIMChatroomSendTipOptions
Returns NIMChatroomMessage

setOptions

setOptions(_options: NIMChatroomGetInstanceOptions): void

Parameters
- _options: NIMChatroomGetInstanceOptions
Returns void

stripImageMeta

stripImageMeta(_options: { done: NIMDefaultDoneFn<string>; url: string }): string

Implementation of CloudStorageInterface.stripImageMeta

去除图片元信息

// todo 主动转长链处理

Parameters
- _options: { done: NIMDefaultDoneFn<string>; url: string }
  - done: NIMDefaultDoneFn<string>
  - url: string
Returns string

thumbnailImage

thumbnailImage(_options: NIMThumbnailImageOptions): void

Implementation of CloudStorageInterface.thumbnailImage

生成图片的略缩图

// todo 主动转长链处理

Parameters
- _options: NIMThumbnailImageOptions
Returns void

updateChatroom

updateChatroom(_options: NIMUpdateChatroomOptions): void

Parameters
- _options: NIMUpdateChatroomOptions
Returns void

updateTags

updateTags(_options: NIMUpdateTagsOptions): void

Parameters
- _options: NIMUpdateTagsOptions
Returns void

viewImageBlur

viewImageBlur(_options: NIMStrAnyObj): string

Implementation of CloudStorageInterface.viewImageBlur
Parameters
- _options: NIMStrAnyObj
Returns string

viewImageCrop

viewImageCrop(_options: NIMStrAnyObj): string

Implementation of CloudStorageInterface.viewImageCrop
Parameters
- _options: NIMStrAnyObj
Returns string

viewImageInterlace

viewImageInterlace(_options: NIMStrAnyObj): string

Implementation of CloudStorageInterface.viewImageInterlace
Parameters
- _options: NIMStrAnyObj
Returns string

viewImageQuality

viewImageQuality(_options: NIMStrAnyObj): string

Implementation of CloudStorageInterface.viewImageQuality
Parameters
- _options: NIMStrAnyObj
Returns string

viewImageRotate

viewImageRotate(_options: NIMStrAnyObj): string

Implementation of CloudStorageInterface.viewImageRotate
Parameters
- _options: NIMStrAnyObj
Returns string

viewImageStripMeta

viewImageStripMeta(_options: NIMStrAnyObj): string

Implementation of CloudStorageInterface.viewImageStripMeta
Parameters
- _options: NIMStrAnyObj
Returns string

viewImageThumbnail

viewImageThumbnail(_options: NIMStrAnyObj): string

Implementation of CloudStorageInterface.viewImageThumbnail
Parameters
- _options: NIMStrAnyObj
Returns string

Static getInstance

getInstance(_options: NIMChatroomGetInstanceOptions): Chatroom

Parameters
- _options: NIMChatroomGetInstanceOptions
Returns Chatroom

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

__options: NIMChatroomGetInstanceOptions

Returns Chatroom

Methods

addListener

Type Parameters

T extends string | symbol

Parameters

event: T

fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns Chatroom

audioToMp3

Parameters

_options: { url: string }

url: string

Returns string

audioToText

Parameters

_options: { done: NIMDefaultDoneFn<string>; url: string }

done: NIMDefaultDoneFn<string>

url: string

Returns void

blurImage

Parameters

_options: NIMBlurImageOptions

Returns void

closeChatroom

Parameters

_options: { custom?: string; done?: NIMDefaultDoneFn<void> }

Optional custom?: string

Optional done?: NIMDefaultDoneFn<void>

Returns void

connect

Returns void

cropImage

Parameters

_options: NIMCropImageOptions

Returns void

deleteNosAccessToken

Parameters

_options: NIMGetNosAccessTokenOptions

Returns void

disconnect

Returns void

emit

Type Parameters

T extends string | symbol

Parameters

event: T

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getChatroom

Parameters

_options: { done?: NIMDefaultDoneFn<NIMChatRoomInfo> }

Optional done?: NIMDefaultDoneFn<NIMChatRoomInfo>

Returns void

getChatroomMembers

Parameters

_options: NIMChatroomGetChatroomMembersOptions

Returns void

getChatroomMembersByTag

Parameters

_options: { done: NIMDefaultDoneFn<{ members: NIMChatroomMember[] }>; tag: string }

done: NIMDefaultDoneFn<{ members: NIMChatroomMember[] }>

tag: string

Returns void

getChatroomMembersInfo