-
Notifications
You must be signed in to change notification settings - Fork 45
docs: clear up default message persistence behavior for chat rooms #3038
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
splindsay-92
wants to merge
2
commits into
main
Choose a base branch
from
chat/clearly-list-defualt-channel-behaviour
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,14 @@ It is important to note that each room is backed by a single Ably Pub/Sub channe | |
|
|
||
| The channel name is the same as the room name with an appended suffix of `::$chat` (e.g `some-room-id::$chat`). In most cases, you will not need to worry about this, as the Chat SDK handles the channel creation and management for you and capabilities can be configured at the room level. | ||
|
|
||
| ### Message persistence <a id="persistence"/> | ||
|
|
||
| The `::$chat` suffix applied to chat room channels enables intrinsic default behaviors that differ from standard Pub/Sub channels. One of the most important behaviors is message persistence. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think we need to add
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| Chat room channels have persistence enabled by default with a retention period of 30 days. This ensures that messages are automatically stored and can be retrieved using the [history feature](/docs/chat/rooms/history). | ||
|
|
||
| The default 30-day retention period can be extended up to 365 days by [contacting us](https://ably.com/support). This automatic persistence is essential for supporting features such as [message updates](/docs/chat/rooms/messages#update), [message deletions](/docs/chat/rooms/messages#delete), and [message reactions](/docs/chat/rooms/message-reactions), all of which require access to previously sent messages. | ||
|
|
||
| ## Use a room <a id="create"/> | ||
|
|
||
| Users send messages to a room and subscribe to the room in order to receive messages. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This para is probably too much detail for the docs, I think we can remove it and let the following two do the talking.