-In this use case, Control API is used to provision a sample app for review and testing purposes. Once provisioned, the "realtime":/api/realtime-sdk or "REST API":/api/rest-api can be used to test the app as needed. Once fully tested, the Control API can be used to replicate the app for users as required, using the known-good configuration.
+In this use case, Control API is used to provision a sample app for review and testing purposes. Once provisioned, the "realtime":/docs/api/realtime-sdk or "REST API":/docs/api/rest-api can be used to test the app as needed. Once fully tested, the Control API can be used to replicate the app for users as required, using the known-good configuration.
In order to use the Control API you must first create an access token in the "Ably dashboard":https://ably.com/accounts/any. You can then use the Control API to manage many account functions without having to interact with the dashboard.
@@ -123,7 +123,7 @@ Sample response:
h2(#ids). Account ID and app ID
-Operations that affect your entire account, such as "listing the apps":/api/control-api/#operation/listApps associated with that account, require an account ID. Those that affect individual apps, such as "creating an API key":/api/control-api/#tag/keys/paths/~1apps~1{app_id}~1keys/post, require an app ID.
+Operations that affect your entire account, such as "listing the apps":/docs/api/control-api/#operation/listApps associated with that account, require an account ID. Those that affect individual apps, such as "creating an API key":/docs/api/control-api/#tag/keys/paths/~1apps~1{app_id}~1keys/post, require an app ID.
h3(#account-id). How to find your account ID
@@ -178,7 +178,7 @@ curl --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_I
}'
```
-See the "API reference":/api/control-api#tag/accounts/paths/~1accounts~1{account_id}~1stats/get for information on the request body.
+See the "API reference":/docs/api/control-api#tag/accounts/paths/~1accounts~1{account_id}~1stats/get for information on the request body.
Sample response, with @entries@ trimmed for readability:
@@ -243,7 +243,7 @@ curl --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_I
}'
```
-See the "API reference":/api/control-api/#tag/apps/paths/~1accounts~1{account_id}~1apps/post for information on the request body.
+See the "API reference":/docs/api/control-api/#tag/apps/paths/~1accounts~1{account_id}~1apps/post for information on the request body.
Sample response:
@@ -302,7 +302,7 @@ curl --location --request POST 'https://control.ably.net/v1/apps/${APP_ID}/stats
}'
```
-See the "API reference":/api/control-api#tag/apps/paths/~1apps~1{app_id}~1stats/get for information on the request body.
+See the "API reference":/docs/api/control-api#tag/apps/paths/~1apps~1{app_id}~1stats/get for information on the request body.
Sample response, with @entries@ trimmed for readability:
@@ -325,7 +325,7 @@ Sample response, with @entries@ trimmed for readability:
h3(#examples-queues). Queues
-You can use the Control API to manage "Ably queues":/general/queues. The main operations are:
+You can use the Control API to manage "Ably queues":/docs/general/queues. The main operations are:
* List all Ably queues
* Create a queue
@@ -394,7 +394,7 @@ curl --location --request POST 'https://control.ably.net/v1/apps/${APP_ID}/queue
}'
```
-See the "API reference":/api/control-api/#tag/queues/paths/~1apps~1{app_id}~1queues/post for information on the request body.
+See the "API reference":/docs/api/control-api/#tag/queues/paths/~1apps~1{app_id}~1queues/post for information on the request body.
Sample response:
@@ -577,7 +577,7 @@ In this case there is only a status code returned (200), or an error code.
h3(#examples-rules). Rules
-You can use the Control API to manage Ably "integration rules":/general/integrations. The main operations are:
+You can use the Control API to manage Ably "integration rules":/docs/general/integrations. The main operations are:
* List all rules for an app
* List details of a specific rule using rule ID
@@ -642,7 +642,7 @@ The rule details are returned for the specified rule.
h4(#examples-rules-create). Create a rule
-The following example creates a rule with the following "configuration":/general/webhooks#configure:
+The following example creates a rule with the following "configuration":/docs/general/webhooks#configure:
|_. Parameter |_. Value |_. Description |
| @ruleType@ | http | The type of rule, in this case a webhook rule |
@@ -653,7 +653,7 @@ The following example creates a rule with the following "configuration":/general
| @format@ | json | Format of encoding for the rule, in this case JSON |
| @name@ | User-Agent | Optional header or headers, including custom headers that might be required. In this case a user agent header is specified (this needs to be set for some providers) |
| @value@ | user-agent-name | The value of the header |
-| @enveloped@ | true | Wrap packet in "metadata":/general/webhooks#envelope |
+| @enveloped@ | true | Wrap packet in "metadata":/docs/general/webhooks#envelope |
The corresponding request is:
@@ -827,4 +827,4 @@ Now that you have obtained the token and IDs, you can learn how to send a reques
-You can now try out other requests. You need to set the necessary parameters and authentication token as required by that specific request. Consult the "API Reference":/api/control-api for further information.
+You can now try out other requests. You need to set the necessary parameters and authentication token as required by that specific request. Consult the "API Reference":/docs/api/control-api for further information.
diff --git a/content/api/index.textile b/content/api/index.textile
index cb0f50c765..8a59c0e71a 100644
--- a/content/api/index.textile
+++ b/content/api/index.textile
@@ -17,17 +17,17 @@ This section of the documentation contains the API references for Ably.
The following API references are available:
-* "Client library Realtime SDK":/api/realtime-sdk
-* "Client library REST SDK":/api/rest-sdk
-* "REST API":/api/rest-api
-* "SSE API":/api/sse
-* "Control API":/api/control-api
+* "Client library Realtime SDK":/docs/api/realtime-sdk
+* "Client library REST SDK":/docs/api/rest-sdk
+* "REST API":/docs/api/rest-api
+* "SSE API":/docs/api/sse
+* "Control API":/docs/api/control-api
h2(#sdks). Client library SDKs
Depending on availability, an Ably client library SDK may support both a realtime interface and a REST interface. Some SDKs only provide a REST interface. You can check availability on the "SDK page":https://ably.com/download.
-The "realtime interface":/api/realtime-sdk allows your client to both publish and subscribe to a channel, but the REST interface only allows you to publish to a channel. The "REST interface":/api/rest-sdk can also be used for non-recurring operations such as obtaining statistics, or checking status. The REST interface has less resource impact, as it is much simpler than the realtime interface.
+The "realtime interface":/docs/api/realtime-sdk allows your client to both publish and subscribe to a channel, but the REST interface only allows you to publish to a channel. The "REST interface":/docs/api/rest-sdk can also be used for non-recurring operations such as obtaining statistics, or checking status. The REST interface has less resource impact, as it is much simpler than the realtime interface.
Typically the REST interface is used on the server, as the server's main task is to authenticate clients, but does not usually need to subscribe to a channel to obtain realtime events.
@@ -47,15 +47,15 @@ The SDKs that have API references generated from source code are:
h2(#rest-api). REST API
-A raw "REST API":/api/rest-api is also provided - you don't need to install any SDK to use this. This is used where an Ably client library SDK is not available for your chosen platform, or you do not wish to use a client library SDK due to resource constraints.
+A raw "REST API":/docs/api/rest-api is also provided - you don't need to install any SDK to use this. This is used where an Ably client library SDK is not available for your chosen platform, or you do not wish to use a client library SDK due to resource constraints.
h2(#sse-api). SSE API
-The "Ably Server-Sent Events API":/api/sse, and raw HTTP streaming API, provide a way to get a realtime stream of events from Ably in circumstances where using a full Ably Realtime client library, or even an MQTT library, is impractical due to resource constraints. HTTP streaming can be used where an SSE client is not supported.
+The "Ably Server-Sent Events API":/docs/api/sse, and raw HTTP streaming API, provide a way to get a realtime stream of events from Ably in circumstances where using a full Ably Realtime client library, or even an MQTT library, is impractical due to resource constraints. HTTP streaming can be used where an SSE client is not supported.
h2(#control-api). Control API
-"Ably Control API":/api/control-api is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure.
+"Ably Control API":/docs/api/control-api is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure.
h2(#spaces). Spaces SDK
diff --git a/content/api/realtime-sdk.textile b/content/api/realtime-sdk.textile
index 2fc44758f2..4188d7f7c8 100644
--- a/content/api/realtime-sdk.textile
+++ b/content/api/realtime-sdk.textile
@@ -33,9 +33,9 @@ jump_to:
- stats#stats-type
- HttpPaginatedResponse#http-paginated-response
redirect_from:
- - /api/versions/v1.1/realtime-sdk
- - /api/versions/v1.0/realtime-sdk
- - /api/versions/v0.8/realtime-sdk
+ - /docs/api/versions/v1.1/realtime-sdk
+ - /docs/api/versions/v1.0/realtime-sdk
+ - /docs/api/versions/v0.8/realtime-sdk
---
inline-toc.
@@ -102,11 +102,11 @@ The Realtime library needs to have credentials to be able to authenticate with t
h4. Basic Authentication
-You can pass a full-length API key in as "__Type: @Object@@ARTRealtimeHistoryQuery@@PaginatedRequestParams@@Hash@"@Param []@":#param__ +- optionsquerydataQuery := an optional object containing the query parametersan optional set of key value pairs containing the query parameters, as specified in the "message history API documentation":/docs/api/realtime-sdk/history#channel-history
__Type: @Object@@ARTRealtimeHistoryQuery@@PaginatedRequestParams@@Hash@"@Param []@":#param__ -
callback
:= is a function of the form: @function(err, resultPage)@
- &block
:= yields a @PaginatedResultcallback
:= called with a "ARTPaginatedResult":#paginated-result<"ARTMessage":#message> object or an error
-Further details of the supported @options@ params, see "message history API documentation":/api/realtime-sdk/history#channel-history.
+Further details of the supported @options@ params, see "message history API documentation":/docs/api/realtime-sdk/history#channel-history.
blang[jsall,objc,swift].
h4. Callback result
@@ -401,7 +401,7 @@ blang[java].
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@Message@":#message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@next@":#paginated-result and "@first@":#paginated-result methods.
- Failure to retrieve the message history will raise an "@AblyException@":/api/realtime-sdk/types#ably-exception
+ Failure to retrieve the message history will raise an "@AblyException@":/docs/api/realtime-sdk/types#ably-exception
blang[csharp].
h4. Returns
@@ -410,32 +410,32 @@ blang[csharp].
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@Message@":#message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@NextAsync@":#paginated-result and "@FirstAsync@":#paginated-result methods.
- Failure to retrieve the message history will raise an "@AblyException@":/api/realtime-sdk/types#ably-exception
+ Failure to retrieve the message history will raise an "@AblyException@":/docs/api/realtime-sdk/types#ably-exception
blang[ruby].
h4. Returns
- A "@Deferrable@":/api/realtime-sdk/types#deferrable object is returned from the method.
+ A "@Deferrable@":/docs/api/realtime-sdk/types#deferrable object is returned from the method.
- On success, the registered success blocks for the "@Deferrable@":/api/realtime-sdk/types#deferrable and any block provided to the method yield a "PaginatedResult":#paginated-result that encapsulates an array of "@Message@":#message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@next()@":#paginated-result and "@first()@":#paginated-result methods.
+ On success, the registered success blocks for the "@Deferrable@":/docs/api/realtime-sdk/types#deferrable and any block provided to the method yield a "PaginatedResult":#paginated-result that encapsulates an array of "@Message@":#message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@next()@":#paginated-result and "@first()@":#paginated-result methods.
- Failure to retrieve the message history will trigger the @errback@ callbacks of the "@Deferrable@":/api/realtime-sdk/types#deferrable with an "@ErrorInfo@":#error-info object with the failure reason.
+ Failure to retrieve the message history will trigger the @errback@ callbacks of the "@Deferrable@":/docs/api/realtime-sdk/types#deferrable with an "@ErrorInfo@":#error-info object with the failure reason.
h6(#attach).
default: attach
csharp: Attach
bq(definition).
- default: attach(callback("ErrorInfo":/api/realtime-sdk/types#error-info err))
+ default: attach(callback("ErrorInfo":/docs/api/realtime-sdk/types#error-info err))
java: void attach()
- csharp: void Attach(Action__Type: @JSONObject@, @JSONArray@plain C# object that can be converted to JSON@JSON Object@@Hash@, @Array@@Dict@, @List@@Dictionary@, @Array@@NSDictionary *@, @NSArray *@@Associative Array@, @Array@__ +Metadata and/or ancillary payloads, if provided. The only currently valid payloads for extras are the "@push@":/push/publish#payload, "@ref@":/channels/messages#interactions and "@privileged@":/docs/general/webhooks#skipping objects.
__Type: @JSONObject@, @JSONArray@plain C# object that can be converted to JSON@JSON Object@@Hash@, @Array@@Dict@, @List@@Dictionary@, @Array@@NSDictionary *@, @NSArray *@@Associative Array@, @Array@__ h6(#id). default: id @@ -120,16 +120,16 @@ h6(#message-from-encoded). bq(definition). default: Message.fromEncoded(Object encodedMsg, ChannelOptions channelOptions?) -> Message -A static factory method to create a "@Message@":/api/realtime-sdk/types#message from a deserialized @Message@-like object encoded using Ably's wire protocol. +A static factory method to create a "@Message@":/docs/api/realtime-sdk/types#message from a deserialized @Message@-like object encoded using Ably's wire protocol. h4. Parameters - encodedMsg := a @Message@-like deserialized object.
__Type: @Object@__ -- channelOptions := an optional "@ChannelOptions@":/api/realtime-sdk/types#channel-options. If you have an encrypted channel, use this to allow the library can decrypt the data.
__Type: @Object@__ +- channelOptions := an optional "@ChannelOptions@":/docs/api/realtime-sdk/types#channel-options. If you have an encrypted channel, use this to allow the library can decrypt the data.
__Type: @Object@__ h4. Returns -A "@Message@":/api/realtime-sdk/types#message object +A "@Message@":/docs/api/realtime-sdk/types#message object h6(#message-from-encoded-array). default: Message.fromEncodedArray @@ -137,13 +137,13 @@ h6(#message-from-encoded-array). bq(definition). default: Message.fromEncodedArray(Object[] encodedMsgs, ChannelOptions channelOptions?) -> Message[] -A static factory method to create an array of "@Messages@":/api/realtime-sdk/types#message from an array of deserialized @Message@-like object encoded using Ably's wire protocol. +A static factory method to create an array of "@Messages@":/docs/api/realtime-sdk/types#message from an array of deserialized @Message@-like object encoded using Ably's wire protocol. h4. Parameters - encodedMsgs := an array of @Message@-like deserialized objects.
__Type: @Array@__ -- channelOptions := an optional "@ChannelOptions@":/api/realtime-sdk/types#channel-options. If you have an encrypted channel, use this to allow the library can decrypt the data.
__Type: @Object@__ +- channelOptions := an optional "@ChannelOptions@":/docs/api/realtime-sdk/types#channel-options. If you have an encrypted channel, use this to allow the library can decrypt the data.
__Type: @Object@__ h4. Returns -An @Array@ of "@Message@":/api/realtime-sdk/types#message objects +An @Array@ of "@Message@":/docs/api/realtime-sdk/types#message objects diff --git a/content/api/realtime-sdk/presence.textile b/content/api/realtime-sdk/presence.textile index 5cd8097950..a0654140c1 100644 --- a/content/api/realtime-sdk/presence.textile +++ b/content/api/realtime-sdk/presence.textile @@ -29,9 +29,9 @@ jump_to: Types: - Related Types#related-types redirect_from: - - /api/versions/v1.1/realtime-sdk/presence - - /api/versions/v1.0/realtime-sdk/presence - - /api/versions/v0.8/realtime-sdk/presence + - /docs/api/versions/v1.1/realtime-sdk/presence + - /docs/api/versions/v1.0/realtime-sdk/presence + - /docs/api/versions/v0.8/realtime-sdk/presence --- inline-toc. @@ -91,8 +91,8 @@ There are two overloaded versions of this method.
callback
:= is a function of the form: @function(err, resultPage)@
- callback
:= called with a "ARTPaginatedResult":#paginated-result<"ARTMessage":#message> object or an error
@@ -240,7 +240,7 @@ blang[java,ruby,php,python].
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@Message@":#message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@next@":#paginated-result and "@first@":#paginated-result methods.
- Failure to retrieve the message history will raise an "@AblyException@":/api/realtime-sdk/types#ably-exception
+ Failure to retrieve the message history will raise an "@AblyException@":/docs/api/realtime-sdk/types#ably-exception
blang[csharp].
h4. Returns
@@ -249,7 +249,7 @@ blang[csharp].
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@Message@":#message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@NextAsync@":#paginated-result and "@FirstAsync@":#paginated-result methods.
- Failure to retrieve the message history will raise an "@AblyException@":/api/realtime-sdk/types#ably-exception
+ Failure to retrieve the message history will raise an "@AblyException@":/docs/api/realtime-sdk/types#ably-exception
blang[go].
h4. Returns
diff --git a/content/api/rest-sdk/encryption.textile b/content/api/rest-sdk/encryption.textile
index eae9797831..00b7a5cb56 100644
--- a/content/api/rest-sdk/encryption.textile
+++ b/content/api/rest-sdk/encryption.textile
@@ -23,9 +23,9 @@ jump_to:
- Channel Options
- CipherParams#cipher-params
redirect_from:
- - /api/versions/v1.1/rest-sdk/encryption
- - /api/versions/v1.0/rest-sdk/encryption
- - /api/versions/v0.8/rest-sdk/encryption
+ - /docs/api/versions/v1.1/rest-sdk/encryption
+ - /docs/api/versions/v1.0/rest-sdk/encryption
+ - /docs/api/versions/v0.8/rest-sdk/encryption
---
inline-toc.
@@ -76,7 +76,7 @@ h4. Parameters
h4. Returns
-On success, the method returns a complete "@CipherParams@":#cipher-params object. Failure will raise an "@AblyException@":/api/rest-sdk/types#ably-exception exception.
+On success, the method returns a complete "@CipherParams@":#cipher-params object. Failure will raise an "@AblyException@":/docs/api/rest-sdk/types#ably-exception exception.
h4. Example
@@ -139,7 +139,7 @@ h6(#generate-random-key).
csharp,go: GenerateRandomKey
bq(definition).
- default: Crypto.generateRandomKey(Int keyLength?, callback("ErrorInfo":/api/rest-sdk/types#error-info err, @Buffer@ key))
+ default: Crypto.generateRandomKey(Int keyLength?, callback("ErrorInfo":/docs/api/rest-sdk/types#error-info err, @Buffer@ key))
ruby: byte array Crypto.generate_random_key(Int key_length?)
python: byte array Crypto.generate_random_key(Int key_length?)
php: string Crypto.generateRandomKey(Int keyLength?)
@@ -165,7 +165,7 @@ blang[jsall].
blang[java,ruby,objc,swift,php,python,csharp,go].
h4. Returns
- On success, the method returns the generated key as a @byte[]@ array@bytes@byte arraybinary string@NSData@@[]byte@ array. Failure will raise an "@AblyException@":/api/rest-sdk/types#ably-exceptionFailure will cause error to contain an "@ErrorInfo@":#error-info object describing the failure reason.
+ On success, the method returns the generated key as a @byte[]@ array@bytes@byte arraybinary string@NSData@@[]byte@ array. Failure will raise an "@AblyException@":/docs/api/rest-sdk/types#ably-exceptionFailure will cause error to contain an "@ErrorInfo@":#error-info object describing the failure reason.
h4. Example
diff --git a/content/api/rest-sdk/history.textile b/content/api/rest-sdk/history.textile
index 4c4363d534..b1fbb4513d 100644
--- a/content/api/rest-sdk/history.textile
+++ b/content/api/rest-sdk/history.textile
@@ -22,9 +22,9 @@ jump_to:
Types:
- Related Types#related-types
redirect_from:
- - /api/versions/v1.1/rest-sdk/history
- - /api/versions/v1.0/rest-sdk/history
- - /api/versions/v0.8/rest-sdk/history
+ - /docs/api/versions/v1.1/rest-sdk/history
+ - /docs/api/versions/v1.0/rest-sdk/history
+ - /docs/api/versions/v0.8/rest-sdk/history
---
inline-toc.
@@ -56,7 +56,7 @@ h6(#channel-history).
csharp,go: History
bq(definition).
- default: history(Object option, callback("ErrorInfo":/api/rest-sdk/types#error-info err, "PaginatedResult":#paginated-result<"Message":#message> resultPage))
+ default: history(Object option, callback("ErrorInfo":/docs/api/rest-sdk/types#error-info err, "PaginatedResult":#paginated-result<"Message":#message> resultPage))
ruby: "PaginatedResult":#paginated-result<"Message":#message> history(Hash option)
python: "PaginatedResult":#paginated-result<"Message":#message> history(kwargs_options)
php: "PaginatedResult":#paginated-result<"Message":#message> history(Array option)
@@ -93,7 +93,7 @@ blang[java,ruby,php,python].
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@Message@":#message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@next@":#paginated-result and "@first@":#paginated-result methods.
- Failure to retrieve the message history will raise an "@AblyException@":/api/rest-sdk/types/#ably-exception
+ Failure to retrieve the message history will raise an "@AblyException@":/docs/api/rest-sdk/types/#ably-exception
blang[go].
h4. Returns
@@ -109,7 +109,7 @@ blang[csharp].
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@Message@":#message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@NextAsync@":#paginated-result and "@FirstAsync@":#paginated-result methods.
- Failure to retrieve the message history will raise an "@AblyException@":/api/rest-sdk/types/#ably-exception
+ Failure to retrieve the message history will raise an "@AblyException@":/docs/api/rest-sdk/types/#ably-exception
h2. Presence object
@@ -122,7 +122,7 @@ h6(#presence-history).
csharp,go: History
bq(definition).
- default: history(Object option, callback("ErrorInfo":/api/rest-sdk/types#error-info err, "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> resultPage))
+ default: history(Object option, callback("ErrorInfo":/docs/api/rest-sdk/types#error-info err, "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> resultPage))
ruby: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> history(Hash option)
python: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> history(kwargs_options)
php: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> history(Array option)
@@ -159,7 +159,7 @@ blang[java,ruby,php,python].
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@PresenceMessage@":#presence-message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@next@":#paginated-result and "@first@":#paginated-result methods.
- Failure to retrieve the presence event history will raise an "@AblyException@":/api/rest-sdk/types/#ably-exception
+ Failure to retrieve the presence event history will raise an "@AblyException@":/docs/api/rest-sdk/types/#ably-exception
blang[go].
h4. Returns
@@ -175,7 +175,7 @@ blang[csharp].
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@PresenceMessage@":#presence-message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@NextAsync@":#paginated-result and "@FirstAsync@":#paginated-result methods.
- Failure to retrieve the presence event history will raise an "@AblyException@":/api/rest-sdk/types/#ably-exception
+ Failure to retrieve the presence event history will raise an "@AblyException@":/docs/api/rest-sdk/types/#ably-exception
h2(#related-types). Related types
diff --git a/content/api/rest-sdk/messages.textile b/content/api/rest-sdk/messages.textile
index 1051c080a2..c12bead9c6 100644
--- a/content/api/rest-sdk/messages.textile
+++ b/content/api/rest-sdk/messages.textile
@@ -26,9 +26,9 @@ jump_to:
Types:
- Related Types#related-types
redirect_from:
- - /api/versions/v1.1/rest-sdk/messages
- - /api/versions/v1.0/rest-sdk/messages
- - /api/versions/v0.8/rest-sdk/messages
+ - /docs/api/versions/v1.1/rest-sdk/messages
+ - /docs/api/versions/v1.0/rest-sdk/messages
+ - /docs/api/versions/v0.8/rest-sdk/messages
---
inline-toc.
@@ -74,7 +74,7 @@ h6(#extras).
default: extras
csharp: Extras
-Metadata and/or ancillary payloads, if provided. The only currently valid payloads for extras are the "@push@":/push/publish#sub-channels, "@ref@":/channels/messages#interactions and "@privileged@":/general/webhooks#skipping objects.__Type: @JSONObject@, @JSONArray@plain C# object that can be converted to JSON@JSON Object@@Hash@, @Array@@Dict@, @List@@Dictionary@, @Array@@NSDictionary *@, @NSArray *@@Associative Array@, @Array@__ +Metadata and/or ancillary payloads, if provided. The only currently valid payloads for extras are the "@push@":/push/publish#sub-channels, "@ref@":/channels/messages#interactions and "@privileged@":/docs/general/webhooks#skipping objects.
__Type: @JSONObject@, @JSONArray@plain C# object that can be converted to JSON@JSON Object@@Hash@, @Array@@Dict@, @List@@Dictionary@, @Array@@NSDictionary *@, @NSArray *@@Associative Array@, @Array@__ h6(#id). default: id @@ -126,16 +126,16 @@ h6(#message-from-encoded). bq(definition). default: Message.fromEncoded(Object encodedMsg, ChannelOptions channelOptions?) -> Message -A static factory method to create a "@Message@":/api/rest-sdk/types#message from a deserialized @Message@-like object encoded using Ably's wire protocol. +A static factory method to create a "@Message@":/docs/api/rest-sdk/types#message from a deserialized @Message@-like object encoded using Ably's wire protocol. h4. Parameters - encodedMsg := a @Message@-like deserialized object.
__Type: @Object@__ -- channelOptions := an optional "@ChannelOptions@":/api/rest-sdk/types#channel-options. If you have an encrypted channel, use this to allow the library can decrypt the data.
__Type: @Object@__ +- channelOptions := an optional "@ChannelOptions@":/docs/api/rest-sdk/types#channel-options. If you have an encrypted channel, use this to allow the library can decrypt the data.
__Type: @Object@__ h4. Returns -A "@Message@":/api/rest-sdk/types#message object +A "@Message@":/docs/api/rest-sdk/types#message object h6(#message-from-encoded-array). default: Message.fromEncodedArray @@ -143,13 +143,13 @@ h6(#message-from-encoded-array). bq(definition). default: Message.fromEncodedArray(Object[] encodedMsgs, ChannelOptions channelOptions?) -> Message[] -A static factory method to create an array of "@Messages@":/api/rest-sdk/types#message from an array of deserialized @Message@-like object encoded using Ably's wire protocol. +A static factory method to create an array of "@Messages@":/docs/api/rest-sdk/types#message from an array of deserialized @Message@-like object encoded using Ably's wire protocol. h4. Parameters - encodedMsgs := an array of @Message@-like deserialized objects.
__Type: @Array@__ -- channelOptions := an optional "@ChannelOptions@":/api/rest-sdk/types#channel-options. If you have an encrypted channel, use this to allow the library can decrypt the data.
__Type: @Object@__ +- channelOptions := an optional "@ChannelOptions@":/docs/api/rest-sdk/types#channel-options. If you have an encrypted channel, use this to allow the library can decrypt the data.
__Type: @Object@__ h4. Returns -An @Array@ of "@Message@":/api/rest-sdk/types#message objects +An @Array@ of "@Message@":/docs/api/rest-sdk/types#message objects diff --git a/content/api/rest-sdk/presence.textile b/content/api/rest-sdk/presence.textile index 734ed069fe..733e801475 100644 --- a/content/api/rest-sdk/presence.textile +++ b/content/api/rest-sdk/presence.textile @@ -22,9 +22,9 @@ jump_to: Types: - Related Types#related-types redirect_from: - - /api/versions/v1.1/rest-sdk/presence - - /api/versions/v1.0/rest-sdk/presence - - /api/versions/v0.8/rest-sdk/presence + - /docs/api/versions/v1.1/rest-sdk/presence + - /docs/api/versions/v1.0/rest-sdk/presence + - /docs/api/versions/v0.8/rest-sdk/presence --- inline-toc. @@ -49,10 +49,10 @@ h6(#get). default: get csharp,go: Get -Get the current presence member set for this channel. In the REST client library this method directly queries "Ably's REST presence API":/api/rest-api#presence +Get the current presence member set for this channel. In the REST client library this method directly queries "Ably's REST presence API":/docs/api/rest-api#presence bq(definition). - default: get(Object options, callback("ErrorInfo":/api/realtime-sdk/types#error-info err, "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> resultPage)) + default: get(Object options, callback("ErrorInfo":/docs/api/realtime-sdk/types#error-info err, "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> resultPage)) ruby: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> get(Hash options) python: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> get(kwargs_options) php: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> get(Array options) @@ -73,8 +73,8 @@ blang[jsall,ruby,python,php,java,swift,objc,go]. h4. @options@ parameters@ARTPresenceQuery@ propertiesArguments -- clientIdclient_id:client_id := when provided, will filter array of members returned that match the provided "@clientId@":/api/rest-sdk#client-options"@client_id@":/api/rest-sdk#client-options"@ClientId@":/api/rest-sdk#client-options string -- connectionIdconnection_id:connection_id := when provided, will filter array of members returned that match the provided @connectionId@@ConnectionId@@connection_id@":/api/realtime-sdk/connection#id string +- clientIdclient_id:client_id := when provided, will filter array of members returned that match the provided "@clientId@":/docs/api/rest-sdk#client-options"@client_id@":/docs/api/rest-sdk#client-options"@ClientId@":/docs/api/rest-sdk#client-options string +- connectionIdconnection_id:connection_id := when provided, will filter array of members returned that match the provided @connectionId@@ConnectionId@@connection_id@":/docs/api/realtime-sdk/connection#id string blang[jsall]. h4. Callback result @@ -90,7 +90,7 @@ blang[java,ruby,php,python,csharp]. On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@PresenceMessage@":#presence-message objects corresponding to the current page of members currently present on the channel. "@PaginatedResult@":#paginated-result supports pagination using "@next@@NextAsync@":#paginated-result and "@first@@FirstAsync@":#paginated-result methods. - Failure to retrieve the current presence member set will raise an "@AblyException@":/api/realtime-sdk/types#ably-exception + Failure to retrieve the current presence member set will raise an "@AblyException@":/docs/api/realtime-sdk/types#ably-exception blang[java,ruby,php,python,csharp]. h4. Returns @@ -104,7 +104,7 @@ blang[java,ruby,php,python,csharp]. h6(#history). History bq(definition). - default: history(Object options, callback("ErrorInfo":/api/rest-sdk/types#error-info err, "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> resultPage)) + default: history(Object options, callback("ErrorInfo":/docs/api/rest-sdk/types#error-info err, "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> resultPage)) ruby: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> history(Hash options) python: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> history(kwargs_options) php: "PaginatedResult":#paginated-result<"PresenceMessage":#presence-message> history(Array options) @@ -136,7 +136,7 @@ blang[java,ruby,php,python,csharp]. On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "@PresenceMessage@":#presence-message objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@next@@NextAsync@":#paginated-result and "@first@@FirstAsync@":#paginated-result methods. - Failure to retrieve the message history will raise an "@AblyException@":/api/realtime-sdk/types#ably-exception + Failure to retrieve the message history will raise an "@AblyException@":/docs/api/realtime-sdk/types#ably-exception blang[go]. h4. Returns diff --git a/content/api/rest-sdk/push-admin.textile b/content/api/rest-sdk/push-admin.textile index f14ea209a4..397050b433 100644 --- a/content/api/rest-sdk/push-admin.textile +++ b/content/api/rest-sdk/push-admin.textile @@ -22,8 +22,8 @@ jump_to: Types: - Related Types#related-types redirect_from: - - /api/rest-sdk/push - - /api/versions/v1.1/rest-sdk/push-admin + - /docs/api/rest-sdk/push + - /docs/api/versions/v1.1/rest-sdk/push-admin --- inline-toc. diff --git a/content/api/rest-sdk/statistics.textile b/content/api/rest-sdk/statistics.textile index ac9dcf13e1..8082367bcb 100644 --- a/content/api/rest-sdk/statistics.textile +++ b/content/api/rest-sdk/statistics.textile @@ -21,9 +21,9 @@ jump_to: Types: - Related Types#related-types redirect_from: - - /api/versions/v1.1/rest-sdk/statistics - - /api/versions/v1.0/rest-sdk/statistics - - /api/versions/v0.8/rest-sdk/statistics + - /docs/api/versions/v1.1/rest-sdk/statistics + - /docs/api/versions/v1.0/rest-sdk/statistics + - /docs/api/versions/v0.8/rest-sdk/statistics --- blang[javascript,nodejs]. @@ -37,16 +37,16 @@ h6(#stats). csharp,go: Stats bq(definition). - jsall: stats(Object options, callback("ErrorInfo":/api/rest-sdk/types#error-info err, "PaginatedResult":/api/rest-sdk/types#paginated-result<"Stats":/api/rest-sdk/types#stats> results)) - ruby: "PaginatedResult":/api/rest-sdk/types#paginated-result<"Stats":/api/rest-sdk/types#stats> stats(Hash options) - python: "PaginatedResult":/api/rest-sdk/types#paginated-result<"Stats":/api/rest-sdk/types#stats> stats(kwargs_options) - php: "PaginatedResult":/api/rest-sdk/types#paginated-result<"Stats":/api/rest-sdk/types#stats> stats(Array options) - java: "PaginatedResult":/api/rest-sdk/types#paginated-result<"Stats":/api/rest-sdk/types#stats-type> stats("Param":#param[] options) - csharp: Task<"PaginatedResult":/api/rest-sdk/types#paginated-result<"Stats":/api/rest-sdk/types#stats-type>> StatsAsync(@StatsRequestParams@ query) - swift,objc: stats(query: ARTStatsQuery?, callback: ("ARTPaginatedResult":#/realtime/types#paginated-result<"ARTStats":/api/realtime-sdk/types#stats>?, ARTErrorInfo?) -> Void) throws + jsall: stats(Object options, callback("ErrorInfo":/docs/api/rest-sdk/types#error-info err, "PaginatedResult":/docs/api/rest-sdk/types#paginated-result<"Stats":/docs/api/rest-sdk/types#stats> results)) + ruby: "PaginatedResult":/docs/api/rest-sdk/types#paginated-result<"Stats":/docs/api/rest-sdk/types#stats> stats(Hash options) + python: "PaginatedResult":/docs/api/rest-sdk/types#paginated-result<"Stats":/docs/api/rest-sdk/types#stats> stats(kwargs_options) + php: "PaginatedResult":/docs/api/rest-sdk/types#paginated-result<"Stats":/docs/api/rest-sdk/types#stats> stats(Array options) + java: "PaginatedResult":/docs/api/rest-sdk/types#paginated-result<"Stats":/docs/api/rest-sdk/types#stats-type> stats("Param":#param[] options) + csharp: Task<"PaginatedResult":/docs/api/rest-sdk/types#paginated-result<"Stats":/docs/api/rest-sdk/types#stats-type>> StatsAsync(@StatsRequestParams@ query) + swift,objc: stats(query: ARTStatsQuery?, callback: ("ARTPaginatedResult":#/docs/realtime/types#paginated-result<"ARTStats":/docs/api/realtime-sdk/types#stats>?, ARTErrorInfo?) -> Void) throws go: (c
+
+
+ You now have a namespace based rule you can apply to channels to enable message interactions or a specific channel with message interactions enabled.
+
+ h3(#use-interactions). Use message interactions
+
+ Once message interactions have been enabled for a channel you can start to reference the @timeSerial@ of previous messages to publish interactions. All messages sent on channels that have interactions enabled will automatically include a @timeSerial@.
+
+ To reference a previous message, include the @ref@ object inside the @extras@ object with:
+
+ * A @type@ constant string defining the reason for interaction. Note that Ably has reserved strings beginning with @com.ably.@.
+ * The @timeserial@ string of the message to interact with.
+
+ The following is an example of sending an emoji reaction:
+
+ ```[javascript]
+ async function sendReaction(emoji) {
+ await channel.publish({
+ name: 'event_name',
+ data: emoji,
+ extras: {
+ ref: {
+ type: "com.ably.reaction",
+ timeserial: "1656424960320-1"
+ }
+ }
+ })
+ }
+ ```
+
+ ```[nodejs]
+ async function sendReaction(emoji) {
+ await channel.publish({
+ name: 'event_name',
+ data: emoji,
+ extras: {
+ ref: {
+ type: "com.ably.reaction",
+ timeserial: "1656424960320-1"
+ }
+ }
+ })
+ }
+ ```
+
+ h3(#listener-interactions). Create a listener
+
+ Regular listeners will get all messages (including those containing a reference), but it is possible to filter specifically for messages with or without a reference by supplying a filter object. A @filter object@ can contain any number of the following fields:
+
+ - @refTimeserial@ (String) := filter containing a specific message timeserial (for example: @v1b25XrTDg:0@).
+ - @refType@ (String) := filter for a specific reference type (for example: @com.ably.reaction@).
+ - @isRef@ (Boolean) := filter for messages that only do or do not reference another message.
+
+ h3(#subscribe-interactions). Subscribe to interactions
+
+ Subscribing to interactions involves sending a filter object defining which interactions you're interested in.
+
+ To subscribe to all reaction interactions:
+
+ ```[realtime_javascript]
+ await channel.subscribe({
+ refType: "com.ably.reaction"
+ }, onReaction);
+ ```
+
+ ```[realtime_nodejs]
+ await channel.subscribe({
+ refType: "com.ably.reaction"
+ }, onReaction);
+ ```
+
+ To subscribe to any interaction:
+
+ ```[realtime_javascript]
+ await channel.subscribe({
+ isRef: true
+ }, onReference);
+ ```
+
+ ```[realtime_nodejs]
+ await channel.subscribe({
+ isRef: true
+ }, onReference);
+ ```
+
+ To subscribe to any non-interaction:
+
+ ```[realtime_javascript]
+ await channel.subscribe({
+ isRef: false
+ }, onRegularMessage);
+ ```
+
+ ```[realtime_nodejs]
+ await channel.subscribe({
+ isRef: false
+ }, onRegularMessage);
+ ```
+
+ To subscribe to interactions to a specific message:
+
+ ```[realtime_javascript]
+ await channel.subscribe({
+ refTimeserial: 'v1b25XrTDg:0'
+ }, onReference);
+ ```
+
+ ```[realtime_nodejs]
+ await channel.subscribe({
+ refTimeserial: 'v1b25XrTDg:0'
+ }, onReference);
+ ```
+
+ To subscribe to a combination of filters:
+
+ ```[realtime_javascript]
+ await channel.subscribe({
+ refTimeserial: 'v1b25XrTDg:0',
+ refType: 'com.ably.reaction',
+ }, onReference);
+ ```
+
+ ```[realtime_nodejs]
+ await channel.subscribe({
+ refTimeserial: 'v1b25XrTDg:0',
+ refType: 'com.ably.reaction',
+ }, onReference);
+ ```
+
+ h3(#unsubscribe-interactions). Unsubscribe from interactions
+
+ Unsubscribing works similar to subscribing, you can unsubscribe by:
+
+ * Passing the filter object to "@unsubscribe()@":/docs/api/realtime-sdk/channels#unsubscribe and, or
+ * Passing the filter function to "@unsubscribe()@":/docs/api/realtime-sdk/channels#unsubscribe
+
+ For example, to unsubscribe to reaction interactions:
+
+ ```[realtime_javascript]
+ channel.unsubscribe({
+ refType: 'com.ably.reaction'
+ });
+ ```
+
+ ```[realtime_nodejs]
+ channel.unsubscribe({
+ refType: 'com.ably.reaction'
+ });
+ ```
+
+ Passing a filter object will unsubscribe every listener attached to that particular filter unless you also pass the filter function. Unsubscribing with a filter requires *exactly* the same filter object to be passed in.
diff --git a/content/channels/options/deltas.textile b/content/channels/options/deltas.textile
index c2dcee93bd..14cbefbb2a 100644
--- a/content/channels/options/deltas.textile
+++ b/content/channels/options/deltas.textile
@@ -11,7 +11,7 @@ languages:
- ruby
- swift
redirect_from:
- - /realtime/channels/channel-parameters/deltas
+ - /docs/realtime/channels/channel-parameters/deltas
---
The @delta@ channel option enables delta compression. It is applied on the channel you are subscribing to, enabling delta mode.
@@ -24,15 +24,15 @@ As @delta@ only applies to channel subscriptions, it is only available when usin
Using delta mode can significantly reduce the encoded size of each message when the difference between successive message payload sizes are small, relative to the overall size. The reduction can reduce bandwidth costs and transit latencies, and enable greater message throughput on a connection.
-
- 
+
+ 
h2(#processing). Delta processing
Deltas apply to the @data@ property of a "@Message@":/channels/messages payload published via Ably. Other properties, such as @clientId@, @name@, and @extras@ remain unchanged and are not compressed when using deltas.
-Messages retrieved via "history":/storage-history/history, and messages delivered to "integrations":/general/integrations are not compressed.
+Messages retrieved via "history":/storage-history/history, and messages delivered to "integrations":/docs/general/integrations are not compressed.
The @delta@ channel option implementation supports a single representation of a delta, "VCDIFF":https://tools.ietf.org/html/rfc3284.
diff --git a/content/channels/options/encryption.textile b/content/channels/options/encryption.textile
index f1fb188489..2d567a6110 100644
--- a/content/channels/options/encryption.textile
+++ b/content/channels/options/encryption.textile
@@ -14,14 +14,14 @@ languages:
- ruby
- swift
redirect_from:
- - /rest/encryption
- - /rest/versions/v1.1/encryption
- - /rest/versions/v1.0/encryption
- - /rest/versions/v0.8/encryption
- - /realtime/encryption
- - /realtime/versions/v1.1/encryption
- - /realtime/versions/v1.0/encryption
- - /realtime/versions/v0.8/encryption
+ - /docs/rest/encryption
+ - /docs/rest/versions/v1.1/encryption
+ - /docs/rest/versions/v1.0/encryption
+ - /docs/rest/versions/v0.8/encryption
+ - /docs/realtime/encryption
+ - /docs/realtime/versions/v1.1/encryption
+ - /docs/realtime/versions/v1.0/encryption
+ - /docs/realtime/versions/v0.8/encryption
---
"Transport Layer Security (TLS)":https://en.wikipedia.org/wiki/Transport_Layer_Security is enabled by default in Ably SDKs so that data is securely sent to, and received from, Ably. However, messages are not encrypted within the Ably system. Use the encryption channel option to ensure that message payloads are opaque, that they can't be decrypted by Ably, and can only be decrypted by other clients that share your secret key.
@@ -32,7 +32,7 @@ h2(#with-ably). Encryption with Ably
Ably SDKs support encryption purely as a convenience. The SDKs ensure interoperability between environments by having compatible implementations of encryption algorithms and by making common choices on things such as format, mode and padding. However, Ably intentionally does not manage the distribution of keys between clients, and end-to-end encryption is enabled without exposing keys to the Ably service at all. This has the advantage that Ably has no access to the un-encrypted contents of your messages, but also means that each app is responsible for enabling the distribution of keys to clients independently of Ably.
-Encryption with Ably supports symmetric encryption only and requires each participating client to each specify the correct "@CipherParams@":/api/realtime-sdk/encryption#cipher-params secret @key@ when creating a @channel@ instance. Clients that do not specify a key will receive the still-encrypted message payloads, that they can subsequently decrypt offline if necessary.
+Encryption with Ably supports symmetric encryption only and requires each participating client to each specify the correct "@CipherParams@":/docs/api/realtime-sdk/encryption#cipher-params secret @key@ when creating a @channel@ instance. Clients that do not specify a key will receive the still-encrypted message payloads, that they can subsequently decrypt offline if necessary.
Only the AES algorithm, with a default key length of 256 bits, and CBC mode are supported. These defaults are intended to ensure that encryption support can be provided in all target environments and platforms.
@@ -44,9 +44,9 @@ The key that's in use at any given time is known by the SDK. The Ably service on
h2(#encrypt). Encrypt a channel
-Set the @cipher@ property to enable message encryption by passing a "@CipherParams@":/api/realtime-sdk/encryption#cipher-params object that contains at least a secret @key@.
+Set the @cipher@ property to enable message encryption by passing a "@CipherParams@":/docs/api/realtime-sdk/encryption#cipher-params object that contains at least a secret @key@.
-A @key@ should be a cryptographic key generated from a secure random source, 128 or 256 bits long and binary or base-64 encoded. Ably SDKs are also capable of "generating a random key":/api/realtime-sdk/encryption#generate-random-key. If you wish to encrypt messages with a pass-phrase, for example one entered by a user then use a "key derivation function":https://en.wikipedia.org/wiki/Key_derivation_function to transform that into a key.
+A @key@ should be a cryptographic key generated from a secure random source, 128 or 256 bits long and binary or base-64 encoded. Ably SDKs are also capable of "generating a random key":/docs/api/realtime-sdk/encryption#generate-random-key. If you wish to encrypt messages with a pass-phrase, for example one entered by a user then use a "key derivation function":https://en.wikipedia.org/wiki/Key_derivation_function to transform that into a key.
The following is an example of setting encryption when obtaining a channel instance:
diff --git a/content/channels/options/index.textile b/content/channels/options/index.textile
index e575c40fbc..ddf4f6eb53 100644
--- a/content/channels/options/index.textile
+++ b/content/channels/options/index.textile
@@ -14,9 +14,9 @@ languages:
- ruby
- swift
redirect_from:
- - /realtime/channels/channel-parameters/overview
- - /realtime/channel-params
- - /realtime/versions/v1.1/channel-params
+ - /docs/realtime/channels/channel-parameters/overview
+ - /docs/realtime/channel-params
+ - /docs/realtime/versions/v1.1/channel-params
---
Channel options can be used to customize the functionality of channels. This includes enabling features such as "encryption":/channels/options/encryption and "deltas":/channels/options/deltas, or for a client to retrieve messages published prior to it attaching to a channel using "rewind":/channels/options/rewind.
@@ -31,12 +31,12 @@ h2(#set). Set channel options
Channel options can be set in two different ways:
-* When a channel instance is first obtained using "@channels.get()@":/api/realtime-sdk/channels#get.
+* When a channel instance is first obtained using "@channels.get()@":/docs/api/realtime-sdk/channels#get.
* Using @channel.setOptions()@ at any point after the channel instance has been obtained.
h3(#get). channels.get
-Pass a @channelOptions@ object into the call to "@get()@":/api/realtime-sdk/channels#get in order to set the desired channel options when obtaining a channel instance.
+Pass a @channelOptions@ object into the call to "@get()@":/docs/api/realtime-sdk/channels#get in order to set the desired channel options when obtaining a channel instance.
The following is an example of setting the @cipher@ property to set "encryption":/channels/options/encryption when obtaining a channel instance:
diff --git a/content/channels/options/rewind.textile b/content/channels/options/rewind.textile
index 3087e52b3a..34e3e7263f 100644
--- a/content/channels/options/rewind.textile
+++ b/content/channels/options/rewind.textile
@@ -13,7 +13,7 @@ languages:
- swift
- go
redirect_from:
- - /realtime/channels/channel-parameters/rewind
+ - /docs/realtime/channels/channel-parameters/rewind
---
The @rewind@ channel option enables a client to specify where to start an attachment from, when attaching to a channel. Rewind can provide context to clients attaching to a channel by passing them previously published messages, such as in the example of a joining a chat room.
@@ -28,7 +28,7 @@ h2(#subscribe). Subscribe with rewind
The @rewind@ property of @params@ can be set at a point in time in the past, or for a given number of messages.
-@rewind@ can also be set by qualifying a channel name during a call to "@get()@":/api/realtime-sdk/channels#get. For example, if you want to subscribe to channel @my_channel@ and fetch the most recent message, you would specify the channel as @[?rewind=1]my_channel@. If the channel also contains metadata, you would apply rewind with @[some_metadata?rewind=1]my_channel@.
+@rewind@ can also be set by qualifying a channel name during a call to "@get()@":/docs/api/realtime-sdk/channels#get. For example, if you want to subscribe to channel @my_channel@ and fetch the most recent message, you would specify the channel as @[?rewind=1]my_channel@. If the channel also contains metadata, you would apply rewind with @[some_metadata?rewind=1]my_channel@.