[**RongIMLib**](../README.md)

***

[RongIMLib](../globals.md) / getChatRoomInfo

# Function: getChatRoomInfo()

> **getChatRoomInfo**(`targetId`, `options?`): `Promise`\<[`RCResult`](../interfaces/RCResult.md)\<[`IChatroomInfo`](../interfaces/IChatroomInfo.md)\>\>

查询聊天室房间信息

## Parameters

### targetId

`string`

聊天室 ID

### options?

[`IGetChatroomInfoOptions`](../type-aliases/IGetChatroomInfoOptions.md)

查询聊天室信息配置参数

## Returns

`Promise`\<[`RCResult`](../interfaces/RCResult.md)\<[`IChatroomInfo`](../interfaces/IChatroomInfo.md)\>\>

返回一个 [RCResult](../interfaces/RCResult.md) 类型 Promise，data 为 [IChatroomInfo](../interfaces/IChatroomInfo.md) 类型

## Description

获取聊天室的信息，返回聊天室成员总数和指定数量（最多 20 个）的聊天室成员的列表，包括该成员的用户 ID 以及加入聊天室的时间
* **注意**：
1. count 或 order 有一个为 0 时，只返回成员总数，不返回成员列表信息，order 人员排序方式，`1` 为正序，`2` 为倒序，默认为 `0` 不返回
2. 单个设备每秒钟支持调用一次，每分钟单个设备最多调用 20 次

## Example

查询聊天室房间信息示例：
```ts
const chatRoomId = 'chatroomId';
const options = { count: 10, order: 1 };
const res = await RongIMLib.getChatRoomInfo(chatRoomId, options);
console.log('查询聊天室房间信息结果：', res);
```