Skip to content

[AIT-1107] docs(liveobjects): migrate Java documentation to the path-based API #3462

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.

Sign up for GitHub

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
sacOO7 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[AIT-1107] docs(liveobjects): migrate Java documentation to the path-based API #3462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94daf80
docs(liveobjects): migrate Java snippets and prose to the path-based API
sacOO7 Jul 8, 2026
0e114e4
docs(liveobjects): warn against blocking on join() in Java examples
sacOO7 Jul 8, 2026
2f792eb
docs(liveobjects): address PR review — readability, version, join() c…
sacOO7 Jul 8, 2026
a8f2d03
docs(liveobjects): note compactJson() nullability on counter path reads
sacOO7 Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/data/nav/liveobjects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export default {
{
name: 'Batch operations',
link: '/docs/liveobjects/batch',
languages: ['javascript', 'swift', 'java'],
},
{
name: 'Lifecycle events',
Expand All @@ -97,6 +98,7 @@ export default {
{
name: 'Object storage',
link: '/docs/liveobjects/storage',
languages: ['javascript', 'swift', 'java'],
},
{
name: 'Using the REST SDK',
Expand Down Expand Up @@ -128,7 +130,8 @@ export default {
external: true,
},
{
link: 'https://sdk.ably.com/builds/ably/ably-java/main/javadoc/io/ably/lib/objects/RealtimeObjects.html',
// TODO: verify this URL resolves once the path-based API javadoc is published
link: 'https://sdk.ably.com/builds/ably/ably-java/main/javadoc/io/ably/lib/liveobjects/RealtimeObject.html',
Comment thread
coderabbitai[bot] marked this conversation as resolved.
name: 'Java SDK',
external: true,
},
Expand Down
6 changes: 3 additions & 3 deletions src/pages/docs/api/realtime-sdk/channels.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,13 @@ Provides access to the [`RealtimeAnnotations`](#realtime-annotations) object for

</If>

<If lang="javascript">
<If lang="javascript,java">
#### object <a id="object" />

Provides access to the [RealtimeObject](/docs/liveobjects) for this channel which can be used to read, modify and subscribe to LiveObjects on a channel.
<If lang="javascript">Provides access to the [RealtimeObject](/docs/liveobjects) for this channel which can be used to read, modify and subscribe to LiveObjects on a channel.</If><If lang="java">A public field providing access to the [RealtimeObject](/docs/liveobjects) for this channel, which can be used to read, modify and subscribe to LiveObjects on a channel.</If>
</If>

<If lang="swift,java">
<If lang="swift">
#### objects <a id="objects" />

Provides access to the [Objects](/docs/liveobjects) object for this channel which can be used to read, modify and subscribe to LiveObjects on a channel.
Expand Down
14 changes: 13 additions & 1 deletion src/pages/docs/liveobjects/batch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,19 @@ meta_description: "Group multiple objects operations into a single channel messa
</Aside>
</If>

<If lang="swift">
<Aside data-type="note">
Batch operations are only currently only supported in LiveObjects JavaScript. Support for Swift and Java is coming soon.
Batch operations are not yet supported in LiveObjects Swift; support is coming soon.
</Aside>
</If>

<If lang="java">
<Aside data-type="note">
Batch operations are not yet supported in the Java SDK. Each mutation (`set`, `remove`, `increment`, `decrement`) publishes as its own message and is individually atomic. See the [LiveMap](/docs/liveobjects/map) and [LiveCounter](/docs/liveobjects/counter) documentation for the single-operation methods.
</Aside>
</If>

<If lang="javascript">

Batch operations allow multiple updates to be grouped into a single channel message and applied atomically. It ensures that all operations in a batch either succeed together or are discarded entirely. Batching is essential when multiple related updates to channel objects must be applied as a single atomic unit, for example, when application logic depends on multiple objects being updated simultaneously. Batching ensures that all operations in the batch either succeed or fail together.

Expand Down Expand Up @@ -269,3 +279,5 @@ await myObject.batch((ctx) => {
// Update: map.set qux
```
</Code>

</If>
Loading