Skip to content

docs(liveobjects): migrate Swift documentation to the path-based API #3515

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 3 commits into
base: main
Choose a base branch
from
Open

docs(liveobjects): migrate Swift documentation to the path-based API #3515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a10808
docs(liveobjects): migrate Swift documentation to the path-based API
sacOO7 Aug 6, 2026
ed5e024
docs(liveobjects): fix two dangling REST API anchor links
sacOO7 Aug 6, 2026
774a1fb
docs(liveobjects): use explicit optional patterns in Swift if-case ex…
sacOO7 Aug 7, 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
2 changes: 1 addition & 1 deletion src/data/languages/languageData.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export default {
},
liveObjects: {
javascript: '2.21',
swift: '0.4',
swift: '1.2',
java: '1.8',
},
liveSync: {
Expand Down
5 changes: 3 additions & 2 deletions src/data/nav/liveobjects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,9 @@ export default {
external: true,
},
{
link: 'https://sdk.ably.com/builds/ably/ably-liveobjects-swift-plugin/main/AblyLiveObjects/documentation/ablyliveobjects/',
name: 'Swift plugin',
// TODO: verify this URL resolves once the ably-cocoa-hosted AblyLiveObjects DocC is published
link: 'https://sdk.ably.com/builds/ably/ably-cocoa/main/AblyLiveObjects/documentation/ablyliveobjects/',
name: 'Swift SDK',
external: true,
},
{
Expand Down
9 changes: 3 additions & 6 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 @@ -103,18 +103,15 @@ Provides access to the [`RealtimeAnnotations`](#realtime-annotations) object for

</If>

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

<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">
#### 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.
An extension property provided by the AblyLiveObjects plugin, giving 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>

### Channel Methods
Expand Down
2 changes: 1 addition & 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 @@ -25,7 +25,7 @@ meta_description: "Group multiple objects operations into a single channel messa

<If lang="swift">
<Aside data-type="note">
Batch operations are not yet supported in LiveObjects Swift; support is coming soon.
Batch operations are not supported in LiveObjects Swift. Each mutation (`set`, `remove`, `increment`, `decrement`) publishes as its own message and is individually atomic. See the [LiveMap](/docs/liveobjects/map?lang=swift) and [LiveCounter](/docs/liveobjects/counter?lang=swift) documentation for the single-operation methods. To apply multiple operations atomically, use [batch operations via the LiveObjects REST API](/docs/liveobjects/rest-api-usage#batch-operations) instead.
</Aside>
</If>

Expand Down
Loading