Skip to content

Commit

Permalink
Modify Agora Chat Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
haoxiuwen committed Oct 25, 2024
1 parent ce5feaa commit 2d6e69a
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ ChatClient.getInstance()

### Update the chat group announcements

Only the chat group owner and admins can call `updateGroupAnnouncement` to set and update the announcements. Once the chat group announcements are updated, all the other chat group members receive the `IGroupManagerDelegate#OnAnnouncementChangedFromGroup` callback. The maximum total length of chat group announcements is 512 characters.
Only the chat group owner and admins can call `updateGroupAnnouncement` to set and update the announcements. Once the chat group announcements are updated, all the other chat group members receive the `IGroupManagerDelegate#onAnnouncementChanged` callback. The maximum total length of chat group announcements is 512 characters.

The following code sample shows how to update the chat group announcements:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This page shows how to use the Agora Chat SDK to manage the attributes of a chat

## Understand the tech

The Agora Chat SDK provides the `GroupManager` and `Group` classes for chat group management, which allows you to implement the following features:
The Agora Chat SDK provides the following group attribute management features:

- Modify the chat group name and description
- Manage chat group announcements
Expand Down Expand Up @@ -75,7 +75,7 @@ Refer to the following sample code to manage chat group shared files:

```javascript
// All chat group members can call uploadGroupSharedFile to upload group shared files. The file size can be up to 10 MB.
// Once shared files are uploaded, group members receive the onSharedFileAdded callback.
// Once shared files are uploaded, group members receive the uploadFile callback.
let option = {
groupId: "groupId",
file: file, // <input type="file"/>Choose the file to upload and share.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Refer to the following sample code to mute and unmute all the chat group members
The chat group owner and admins are added to the chat group allow list by default.
Members in the chat group allow list can send chat group messages even when the chat group owner or admin has muted all chat group members. However, if a member is already in the chat group mute list, adding this member to the allow list does not take effect.
Members in the chat group allow list can send chat group messages even when the chat group owner or admin has muted all chat group members. However, if a member is already in the chat group mute list, this member still cannot send send messages in the group even after being added to the allow list.
Refer to the following sample code to manage the chat group allow list:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ ChatClient.getInstance()

#### Transfer the chat group ownership

Only the chat group owner can call `changeOwner` to transfer the ownership to the specified chat group member. Once the ownership is transferred, the former chat group owner becomes a regular member, and the new owner receives the `ChatGroupEventListener#OnOwnerChangedFromGroup` callback.
Only the chat group owner can call `changeOwner` to transfer the ownership to the specified chat group member. Once the ownership is transferred, the former chat group owner becomes a regular member, and the new owner receives the `ChatGroupEventListener#OnOwnerChanged` callback.

The following code sample shows how to transfer the chat group ownership:

Expand All @@ -85,7 +85,7 @@ ChatClient.getInstance()

#### Add a chat group admin

Only the chat group owner can call `addAdmin` to add an admin. Once promoted to an admin, the new admin and the other chat group admins receive the `ChatGroupEventListener#OnAdminAddedFromGroup` callback.
Only the chat group owner can call `addAdmin` to add an admin. Once promoted to an admin, the new admin and the other chat group admins receive the `ChatGroupEventListener#OnAdminAdded` callback.

The following code sample shows how to add a chat group admin:

Expand All @@ -102,7 +102,7 @@ ChatClient.getInstance()

#### Remove a chat group admin

Only the chat group owner can call `removeAdmin` to remove an admin. Once demoted to a regular member, the former admin and the other chat group admins receive the `ChatGroupEventListener#OnAdminRemovedFromGroup` callback.
Only the chat group owner can call `removeAdmin` to remove an admin. Once demoted to a regular member, the former admin and the other chat group admins receive the `ChatGroupEventListener#OnAdminRemoved` callback.

The following code sample shows how to remove a chat group admin:

Expand Down Expand Up @@ -192,7 +192,7 @@ ChatClient.getInstance()

#### Remove a member from the chat group mute list

Only the chat group owner and admins can call `unMuteMembers` to remove the specified member from the chat group mute list. Once removed from the chat group mute list, this member and all the other chat group admins or owner receive the `ChatGroupEventListener#OnMuteListRemovedFromGroup` callback.
Only the chat group owner and admins can call `unMuteMembers` to remove the specified member from the chat group mute list. Once removed from the chat group mute list, this member and all the other chat group admins or owner receive the `ChatGroupEventListener#onMuteListRemoved` callback.

The following code sample shows how to remove a member from the chat group mute list:

Expand Down Expand Up @@ -270,7 +270,7 @@ The chat group owner and admins are added to the chat group allow list by defaul

#### Add a member to the chat group allow list

Only the chat group owner and admins can call `addAllowList` to add the specified member to the chat group allow list. Members in the chat group allow list can send chat group messages even when the chat group owner or admin has muted all chat group members. However, if a member is already in the chat group mute list, adding this member to the allow list does not enable them to send messages. The mute list takes precedence.
Only the chat group owner and admins can call `addAllowList` to add the specified member to the chat group allow list. Members in the chat group allow list can send chat group messages even when the chat group owner or admin has muted all chat group members. However, if a member is already in the chat group mute list, adding this member to the allow list still does not enable them to send messages. The mute list takes precedence.

The following code sample shows how to add a member to the chat group allow list:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ conn.enableSendGroupMsg(options).then(res => console.log(res))

The chat group owner and admins are added to the chat group allow list by default.

Members in the chat group allow list can send chat group messages even when the chat group owner or admin has muted all chat group members. However, if a member is already in the chat group mute list, adding this member to the allow list does not take effect.
Members in the chat group allow list can send chat group messages even when the chat group owner or admin has muted all chat group members. However, if a member is already in the chat group mute list, this member still cannot send send messages in the group even after being added to the allow list.

Refer to the following sample code to manage the chat group allow list:

Expand Down

0 comments on commit 2d6e69a

Please sign in to comment.