Skip to content

Commit

Permalink
Merge pull request #3318 from haoxiuwen/agora-chat
Browse files Browse the repository at this point in the history
Modify Agora Chat EN Docs
  • Loading branch information
haoxiuwen authored Sep 15, 2023
2 parents c9ec915 + 1576b26 commit 8a1ef4f
Show file tree
Hide file tree
Showing 13 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Chat rooms enable real-time messaging among multiple users.

Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once a chat room member goes offline, this member does not receive any push messages from the chat room and automatically leaves the chat room after 5 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.
Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once going offline, chat room members cannot receive any messages from the chat room and automatically leave the chat room after 2 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.

This page shows how to use the Agora Chat SDK to create and manage a chat room in your app.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Chat rooms enable real-time messaging among multiple users.

Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once a chat room member goes offline, this member does not receive any push messages from the chat room and automatically leaves the chat room after 5 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.
Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once going offline, chat room members cannot receive any messages from the chat room and automatically leave the chat room after 2 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.

This page shows how to use the Agora Chat SDK to create and manage a chat room in your app.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Chat rooms enable real-time messaging among multiple users and are widely applied in live broadcast use cases as stream chat in Twitch.. Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once a chat room member goes offline, this member does not receive any push messages from the chat room and automatically leaves the chat room in two minutes. If you want to adjust the time, contact [[email protected]](mailto:[email protected]).
Chat rooms enable real-time messaging among multiple users and are widely applied in live broadcast use cases as stream chat in Twitch. Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once going offline, chat room members cannot receive any messages from the chat room and automatically leave the chat room after 2 minutes. If you want to adjust the time, contact [[email protected]](mailto:[email protected]).

## Chat room roles and privileges

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Chat rooms enable real-time messaging among multiple users.

Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once a chat room member goes offline, this member does not receive any push messages from the chat room and automatically leaves the chat room after 5 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.
Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once going offline, chat room members cannot receive any messages from the chat room and automatically leave the chat room after 2 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.

This page shows how to use the Agora Chat SDK to create and manage a chat room in your app.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Chat rooms enable real-time messaging among multiple users.

Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once a chat room member goes offline, this member does not receive any push messages from the chat room and automatically leaves the chat room after 5 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.
Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once going offline, chat room members cannot receive any messages from the chat room and automatically leave the chat room after 2 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.

This page shows how to use the Agora Chat SDK to create and manage a chat room in your app.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Chat rooms enable real-time messaging among multiple users.

Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once a chat room member goes offline, this member does not receive any push messages from the chat room and automatically leaves the chat room after 5 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.
Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once going offline, chat room members cannot receive any messages from the chat room and automatically leave the chat room after 2 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.

This page shows how to use the Agora Chat SDK to create and manage a chat room in your app.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Chat rooms enable real-time messaging among multiple users.

Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once a chat room member goes offline, this member does not receive any push messages from the chat room and automatically leaves the chat room after 5 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.
Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once going offline, chat room members cannot receive any messages from the chat room and automatically leave the chat room after 2 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.

This page shows how to use the Agora Chat SDK to create and manage a chat room in your app.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Chat rooms enable real-time messaging among multiple users.

Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once a chat room member goes offline, this member does not receive any push messages from the chat room and automatically leaves the chat room after 5 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.
Chat rooms do not have a strict membership, and members do not retain any permanent relationship with each other. Once going offline, chat room members cannot receive any messages from the chat room and automatically leave the chat room after 2 minutes. Chat rooms are widely applied in live broadcast use cases such as stream chat in Twitch.

This page shows how to use the Agora Chat SDK to create and manage a chat room in your app.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ In one-to-one chats, the SDK supports sending both the conversation read receipt
1. Send a conversation read receipt when the recipient enters the conversation.
```java
// The message receiver calls ackMessageRead to send the conversation read receipt.
// The message receiver calls ackConversationRead to send the conversation read receipt.
try {
ChatClient.getInstance().chatManager().ackMessageRead(conversationId);
ChatClient.getInstance().chatManager().ackConversationRead(conversationId);
}catch (ChatException e) {
e.printStackTrace();
}
Expand Down Expand Up @@ -189,11 +189,11 @@ Follow the steps to implement chat message read receipts.
```java
// Set setIsNeedGroupAck as true when sending the group message
ChatMessage message = ChatMessage.createTxtSendMessage(content, to);
ChatMessage message = ChatMessage.createTextSendMessage(content, to);
message.setIsNeedGroupAck(true);
```
2. After the group member reads the chat group message, call `sendAckMessage` from the group member's client to send a message read receipt:
2. After the group member reads the chat group message, call `ackGroupMessageRead` from the group member's client to send a message read receipt:

```java
// Send the group message read receipt.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ WebIM.conn.getHistoryMessages(options).then((res)=>{

### Delete historical messages from the server unidirectionally

Call `removeHistoryMessages` to delete historical messages one way from the server. You can remove a maximum of 50 messages from the server each time. Once the messages are deleted, you can no longer retrieve them from the server. Other chat users can still get the messages from the server.
Call `removeHistoryMessages` to delete historical messages one way from the server. You can remove a maximum of 20 messages from the server each time. Once the messages are deleted, you can no longer retrieve them from the server. Other chat users can still get the messages from the server.

```javascript
// Delete messages by timestamp
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ SDKClient.Instance.Logout(true, callback: new CallBack(

In Unity Editor, select the **Project** tab, select **Assets** > **Scenes**, double-click the `SampleScene.cs` file, and click the **Play** icon at the top of the Unity Editor to run the project.

<div class="alert info">If you have not installed iOS Build Support, remove the <code>iOSBuildSetting.cs</code> file (Path: <code>Assets/ChatSDK/Scripts/Editor</code>) from the project folder before running the project.</div>
<div class="alert info">If you have not installed iOS Build Support, remove the <code>iOSBuildSetting.cs</code> file (Path: <code>Assets/AgoraChat/Scripts/Editor</code>) from the project folder before running the project.</div>

If the sample project runs properly, the following user interface appears:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ curl -L -X DELETE 'http://XXXX/XXXX/XXXX/push/label/post-90s' \

## Add users to a push label

Adds one or more users to the specified push label. A maximum of 200,000 users can be added to a push label. To lift the upper limit, contact <a href="mailto:[email protected]">[email protected]</a>.</div>
Adds one or more users to the specified push label. A maximum of 20,000 users can be added to a push label. To lift the upper limit, contact <a href="mailto:[email protected]">[email protected]</a>.</div>

You can add a maximum of 100 users at each call.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1128,7 +1128,7 @@ This method retrieves historical messages sent and received by the user.
- Messages cannot be retrieved in real time. For example, at 9 a.m., you can retrieve messages that are sent or received at 8 a.m.
- The default storage time of historical messages differs by plan version. For details, see [package details](./agora_chat_plan?platform=RESTful).

For each App Key, the call frequency limit of this method is 100 per second.
For each App Key, the call frequency limit of this method is 10 per minute.

### HTTP request

Expand Down

0 comments on commit 8a1ef4f

Please sign in to comment.