Interface NERoomService

Hierarchy

NERoomService

Index

Properties

createRoom destroy getPreviewRoomContext getRoomCloudRecordList getRoomContext joinRoom joinRoomByInvite previewRoom

Methods

exportChatroomHistoryMessages fetchChatroomHistoryMessages rejectInvite

Properties

createRoom

createRoom: ((params, options) => Promise<NEResult<null>>)

Type declaration

- (params, options): Promise<NEResult<null>>
- 创建一个房间，不会加入房间
  Parameters
  - params: NECreateRoomParams
    
    创建房间的参数
  - options: NECreateRoomOptions
    
    创建房间的选项
  Returns Promise<NEResult<null>>

destroy

destroy: (() => void)

Type declaration

- (): void
- Returns void

getPreviewRoomContext

getPreviewRoomContext: (() => NEPreviewRoomContext)

Type declaration

- (): NEPreviewRoomContext
- 获取PreviewRoomContext 使用此方法，必须先调用previewRoom方法
  
  Returns NEPreviewRoomContext

getRoomCloudRecordList

getRoomCloudRecordList: ((roomArchiveId) => Promise<NEResult<NERoomRecord[]>>)

Type declaration

- (roomArchiveId): Promise<NEResult<NERoomRecord[]>>
- 获取房间云录制列表
  Parameters
  - roomArchiveId: string
    
    房间roomArchiveId
  Returns Promise<NEResult<NERoomRecord[]>>

getRoomContext

getRoomContext: ((roomUuid) => null | NERoomContext)

Type declaration

- (roomUuid): null | NERoomContext
- Parameters
  - roomUuid: string
  Returns null | NERoomContext

joinRoom

joinRoom: ((params, options) => Promise<NEResult<NERoomContext>>)

Type declaration

- (params, options): Promise<NEResult<NERoomContext>>
- 加入房间
  Parameters
  - params: NEJoinRoomParams
    
    加入房间的参数
  - options: NEJoinRoomOptions
    
    加入房间的选项
  Returns Promise<NEResult<NERoomContext>>

joinRoomByInvite

joinRoomByInvite: ((params, options) => Promise<NEResult<NERoomContext>>)

Type declaration

- (params, options): Promise<NEResult<NERoomContext>>
- 通过加入房间
  Parameters
  - params: NEJoinRoomParams
    
    加入房间的参数
  - options: NEJoinRoomOptions
    
    加入房间的选项
  Returns Promise<NEResult<NERoomContext>>

previewRoom

previewRoom: ((params, options) => Promise<NEResult<NEPreviewRoomContext>>)

Type declaration

- (params, options): Promise<NEResult<NEPreviewRoomContext>>
- 房间预览
  Parameters
  - params: NEPreviewRoomParams
    
    房间预览的参数
  - options: NEPreviewRoomOptions
    
    房间预览的选项
  Returns Promise<NEResult<NEPreviewRoomContext>>

Methods

exportChatroomHistoryMessages

exportChatroomHistoryMessages(roomArchiveId): Promise<NEResult<string>>
获取历史消息
Parameters
- roomArchiveId: string
  
  房间唯一id
Returns Promise<NEResult<string>>

fetchChatroomHistoryMessages

fetchChatroomHistoryMessages(roomArchiveId, option): Promise<NEResult<NIMChatroomMessage[]>>
获取历史消息
Parameters
- roomArchiveId: string
- option: {
      limit?: number;
      order?: number;
      startTime?: number;
  }
  - Optional limit?: number
    
    消息数量
  - Optional order?: number
    
    顺序 0 正序 1 倒序
  - Optional startTime?: number
    
    开始时间
Returns Promise<NEResult<NIMChatroomMessage[]>>

rejectInvite

rejectInvite(roomUuid): Promise<NEResult<null>>
挂断邀请的呼叫
Parameters
- roomUuid: string
  
  房间uuid
Returns Promise<NEResult<null>>