Skip to content

[AIT-319] Add LiveObjects REST SDK usage docs #3258

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
VeskeR wants to merge 1 commit into
base: main
Choose a base branch
from
+950 −3
Open

[AIT-319] Add LiveObjects REST SDK usage docs #3258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions src/data/nav/liveobjects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ export default {
name: 'Object storage',
link: '/docs/liveobjects/storage',
},
{
name: 'Using the REST SDK',
link: '/docs/liveobjects/rest-sdk-usage',
},
{
name: 'Using the REST API',
link: '/docs/liveobjects/rest-api-usage',
Expand Down
6 changes: 6 additions & 0 deletions src/pages/docs/api/rest-sdk/channels.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ Provides access to the [REST Presence](/docs/presence-occupancy/presence) object

Provides access to the [PushChannel](/docs/api/realtime-sdk/push#push-channel) object for this channel which can be used to access members present on the channel, or participate in presence.

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

Provides access to the [RestObject](/docs/liveobjects/rest-sdk-usage) for this channel which can be used to read and modify LiveObjects on a channel using the REST SDK.
</If>

### Channel Methods

#### <If lang="javascript,nodejs,php,python,ruby,java,swift,objc,go,flutter">publish</If><If lang="csharp,go">Publish</If>
Expand Down
6 changes: 3 additions & 3 deletions src/pages/docs/liveobjects/rest-api-usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,7 +632,7 @@ There are additional operations for creating objects with client-generated IDs:
{
"objectId": "map:Qj2kkvprTybCY5mkNMcm31hhNKZCDWqcz45LjYvCABs@1769079911168",
"mapCreateWithObjectId": {
"initialValue": "{\"entries\":{\"name\":{\"data\":{\"string\":\"Alice\"}},\"age\":{\"data\":{\"number\":30}}}}",
"initialValue": "{\"semantics\":0,\"entries\":{\"name\":{\"data\":{\"string\":\"Alice\"}},\"age\":{\"data\":{\"number\":30}}}}",
"nonce": "random-nonce-abc123"
}
}
Expand Down Expand Up @@ -677,7 +677,7 @@ For example:
-d '{
"objectId": "map:Qj2kkvprTybCY5mkNMcm31hhNKZCDWqcz45LjYvCABs@1769079911168",
"mapCreateWithObjectId": {
"initialValue": "{\"entries\":{\"name\":{\"data\":{\"string\":\"Alice\"}},\"age\":{\"data\":{\"number\":30}}}}",
"initialValue": "{\"semantics\":0,\"entries\":{\"name\":{\"data\":{\"string\":\"Alice\"}},\"age\":{\"data\":{\"number\":30}}}}",
"nonce": "random-nonce-abc123"
}
}'
Expand All @@ -697,7 +697,7 @@ Create a map and immediately link it to root in a single atomic operation:
{
"objectId": "map:Qj2kkvprTybCY5mkNMcm31hhNKZCDWqcz45LjYvCABs@1769079911168",
"mapCreateWithObjectId": {
"initialValue": "{\"entries\":{\"name\":{\"data\":{\"string\":\"Alice\"}}}}",
"initialValue": "{\"semantics\":0,\"entries\":{\"name\":{\"data\":{\"string\":\"Alice\"}}}}",
"nonce": "nonce-1"
}
},
Expand Down
Loading