THREAD APIS | Agora Chat SDK API Reference

Index

Functions

changeChatThreadName

changeChatThreadName(params: { chatThreadId: string; name: string }): Promise<AsyncResult<ThreadTypes.ChangeChatThreadName>>

修改thread名称
```
connection.changeChatThreadName({chatThreadId: 'chatThreadId',name: 'name'})
```
Parameters
- params: { chatThreadId: string; name: string }
  - chatThreadId: string
    
    子区的 ID。
  - name: string
    
    子区的名称。
Returns Promise<AsyncResult<ThreadTypes.ChangeChatThreadName>>

createChatThread

createChatThread(params: { messageId: string; name: string; parentId: string }): Promise<AsyncResult<ThreadTypes.CreateChatThreadResult>>

创建子区
```
connection.createChatThread({parentId: 'parentId',name: 'threadName',messageId: 'messageId'})
```
Parameters
- params: { messageId: string; name: string; parentId: string }
  - messageId: string
    
    父消息 ID
  - name: string
    
    子区名称。
  - parentId: string
    
    一般指群 ID。
Returns Promise<AsyncResult<ThreadTypes.CreateChatThreadResult>>

destroyChatThread

destroyChatThread(params: { chatThreadId: string }): Promise<void>

删除子区,群主和管理员有此权限。
```
connection.destroyChatThread({chatThreadId: 'chatThreadId'})
```
Parameters
- params: { chatThreadId: string }
  - chatThreadId: string
    
    子区的 ID。
Returns Promise<void>

getChatThreadDetail

getChatThreadDetail(params: { chatThreadId: string }): Promise<AsyncResult<ThreadTypes.ChatThreadDetail>>

获取子区详情
```
connection.getChatThreadDetail({chatThreadId: 'chatThreadId'})
```
Parameters
- params: { chatThreadId: string }
  - chatThreadId: string
    
    子区的 ID。
Returns Promise<AsyncResult<ThreadTypes.ChatThreadDetail>>

getChatThreadLastMessage

getChatThreadLastMessage(params: { chatThreadIds: string[] }): Promise<AsyncResult<ThreadTypes.ChatThreadLastMessage>>

批量获取子区的最新消息内容,最大数20条。
```
connection.getChatThreadLastMessage({chatThreadIds: ['chatThreadId1','chatThreadId2']})
```
Parameters
- params: { chatThreadIds: string[] }
  - chatThreadIds: string[]
    
    要查询的子区 ID 列表。
Returns Promise<AsyncResult<ThreadTypes.ChatThreadLastMessage>>

getChatThreadMembers

getChatThreadMembers(params: { chatThreadId: string; cursor?: string; pageSize?: number }): Promise<AsyncResult<ThreadTypes.ChatThreadMembers>>

分页获取子区成员列表
```
connection.getChatThreadMembers({chatThreadId: 'chatThreadId ',pageSize:20,cursor:'cursor'})
```
Parameters
- params: { chatThreadId: string; cursor?: string; pageSize?: number }
  - chatThreadId: string
    
    子区的 ID。
  - Optional cursor?: string
    
    游标。如果数据还有下一页，该方法的返回值会包含此字段，传递此字段可获取下一页的数据，为 '' 时获取第一页数据
  - Optional pageSize?: number
    
    每页返回的子区数。默认为 20，最大为 50。
Returns Promise<AsyncResult<ThreadTypes.ChatThreadMembers>>

getChatThreads

getChatThreads(params: { cursor?: string; pageSize?: number; parentId: string }): Promise<AsyncResult<ThreadTypes.ChatThreadDetail[]>>

分页获取指定群的子区列表。
```
connection.getChatThreads({parentId: 'parentId, cursor:'cursor' ,pageSize: 50})
```
Parameters
- params: { cursor?: string; pageSize?: number; parentId: string }
  - Optional cursor?: string
    
    游标。如果数据还有下一页，该方法的返回值会包含此字段，传递此字段可获取下一页的数据，为 '' 时获取第一页数据
  - Optional pageSize?: number
    
    每页返回的公开子区数。默认为 20，最大为 50。
  - parentId: string
    
    一般指群 ID。
Returns Promise<AsyncResult<ThreadTypes.ChatThreadDetail[]>>

getJoinedChatThreads

getJoinedChatThreads(params: { cursor?: string; pageSize?: number; parentId?: string }): Promise<AsyncResult<ThreadTypes.ChatThreadDetail[]>>

分页获取加入的子区列表,当parentId不为空时，获取指定群下加入的子区列表。
```
connection.getJoinedChatThreads({parentId: 'parentId',cursor: 'cursor',pageSize: 50})
```
Parameters
- params: { cursor?: string; pageSize?: number; parentId?: string }
  - Optional cursor?: string
    
    游标。如果数据还有下一页，该方法的返回值会包含此字段，传递此字段可获取下一页的数据，为 '' 时获取第一页数据
  - Optional pageSize?: number
    
    每页返回的公开子区数。默认为 20，最大为 50。
  - Optional parentId?: string
    
    一般指群 ID。
Returns Promise<AsyncResult<ThreadTypes.ChatThreadDetail[]>>

joinChatThread

joinChatThread(params: { chatThreadId: string }): Promise<AsyncResult<ThreadTypes.JoinChatThreadResult>>

加入子区
```
connection.joinChatThread({chatThreadId: 'chatThreadId'})
```
Parameters
- params: { chatThreadId: string }
  - chatThreadId: string
    
    子区的 ID。
Returns Promise<AsyncResult<ThreadTypes.JoinChatThreadResult>>

leaveChatThread

leaveChatThread(params: { chatThreadId: string }): Promise<void>

退出子区
```
connection.leaveChatThread({chatThreadId: 'chatThreadId'})
```
Parameters
- params: { chatThreadId: string }
  - chatThreadId: string
    
    子区的 ID。
Returns Promise<void>

removeChatThreadMember

removeChatThreadMember(params: { chatThreadId: string; username: string }): Promise<AsyncResult<ThreadTypes.RemoveMemberResult>>

移除子区成员
```
connection.removeChatThreadMember({chatThreadId: 'chatThreadId',username:'username'})
```
Parameters
- params: { chatThreadId: string; username: string }
  - chatThreadId: string
    
    子区的 ID。
  - username: string
    
    要移除的成员 ID。
Returns Promise<AsyncResult<ThreadTypes.RemoveMemberResult>>

Index

Functions

Functions

changeChatThreadName

Parameters

params: { chatThreadId: string; name: string }

chatThreadId: string

name: string

Returns Promise<AsyncResult<ThreadTypes.ChangeChatThreadName>>

createChatThread

Parameters

params: { messageId: string; name: string; parentId: string }

messageId: string

name: string

parentId: string

Returns Promise<AsyncResult<ThreadTypes.CreateChatThreadResult>>

destroyChatThread

Parameters

params: { chatThreadId: string }

chatThreadId: string

Returns Promise<void>

getChatThreadDetail

Parameters

params: { chatThreadId: string }

chatThreadId: string

Returns Promise<AsyncResult<ThreadTypes.ChatThreadDetail>>

getChatThreadLastMessage

Parameters

params: { chatThreadIds: string[] }

chatThreadIds: string[]

Returns Promise<AsyncResult<ThreadTypes.ChatThreadLastMessage>>

getChatThreadMembers

Parameters

params: { chatThreadId: string; cursor?: string; pageSize?: number }

chatThreadId: string

Optional cursor?: string

Optional pageSize?: number

Returns Promise<AsyncResult<ThreadTypes.ChatThreadMembers>>

getChatThreads

Parameters

params: { cursor?: string; pageSize?: number; parentId: string }

Optional cursor?: string

Optional pageSize?: number

parentId: string

Returns Promise<AsyncResult<ThreadTypes.ChatThreadDetail[]>>

getJoinedChatThreads

Parameters

params: { cursor?: string; pageSize?: number; parentId?: string }

Optional cursor?: string

Optional pageSize?: number

Optional parentId?: string

Returns Promise<AsyncResult<ThreadTypes.ChatThreadDetail[]>>

joinChatThread

Parameters

params: { chatThreadId: string }

chatThreadId: string

Returns Promise<AsyncResult<ThreadTypes.JoinChatThreadResult>>

leaveChatThread

Parameters

params: { chatThreadId: string }

chatThreadId: string

Returns Promise<void>

removeChatThreadMember

Parameters

params: { chatThreadId: string; username: string }

chatThreadId: string

username: string

Returns Promise<AsyncResult<ThreadTypes.RemoveMemberResult>>