fixup! Migrate REST SDK API spec History page to MDX

GregHolmes · GregHolmes · commit f4d7aa8fecb1 · 2025-11-03T16:45:46.000Z
diff --git a/src/pages/docs/api/rest-sdk/history.mdx b/src/pages/docs/api/rest-sdk/history.mdx
@@ -18,9 +18,9 @@ redirect_from:
 
 The [Rest `Channel` object](/docs/channels) exposes the following public method to obtain [`Message`](#message) history.
 
-### Methods <a id="#channel-methods" />
+### Methods <a id="channel-methods" />
 
-### <If lang="javascript,nodejs,java,objc,php,python,ruby,swift">history</If><If lang="csharp,go">History</If> <a id="#channel-history" />
+### <If lang="javascript,nodejs,java,objc,php,python,ruby,swift">history</If><If lang="csharp,go">History</If> <a id="channel-history" />
 
 <If lang="javascript,nodejs">
 
@@ -147,9 +147,9 @@ Failure to retrieve the message history will raise an [`AblyException`](/docs/ap
 
 [Rest `Presence` object](/docs/presence-occupancy/presence) exposes the following public method to obtain presence event history such as enter, update and leave events. These events are represented as [`PresenceMessage`](#presence-message) objects.
 
-### Methods <a id="#presence-methods" />
+### Methods <a id="presence-methods" />
 
-### <If lang="javascript,nodejs,java,objc,php,python,ruby,swift">history</If><If lang="csharp,go">History</If> <a id="#presence-history" />
+### <If lang="javascript,nodejs,java,objc,php,python,ruby,swift">history</If><If lang="csharp,go">History</If> <a id="presence-history" />
 
 <If lang="javascript,nodejs">
 
@@ -272,67 +272,67 @@ Failure to retrieve the presence event history will raise an [`AblyException`](/
 
 </If>
 
-## Related types <a id="#related-types" />
+## Related types <a id="related-types" />
 
-### <If lang="javascript,nodejs,php,python,go">Message</If><If lang="swift,objc">ARTMessage</If><If lang="ruby">Ably::Models::Message Enum</If><If lang="java">io.ably.lib.types.Message</If><If lang="csharp">IO.Ably.Message</If> <a id="#message" />
+### <If lang="javascript,nodejs,php,python,go">Message</If><If lang="swift,objc">ARTMessage</If><If lang="ruby">Ably::Models::Message Enum</If><If lang="java">io.ably.lib.types.Message</If><If lang="csharp">IO.Ably.Message</If> <a id="message" />
 
 A `Message` represents an individual message that is sent to or received from Ably.
 
-### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">name</If><If lang="csharp">Name</If> <a id="#name" />
+### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">name</If><If lang="csharp">Name</If> <a id="name" />
 
 The event name, if provided. <br />_Type: `String`_
 
-### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">data</If><If lang="csharp">Data</If> <a id="#data" />
+### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">data</If><If lang="csharp">Data</If> <a id="data" />
 
 The message payload, if provided.<br />_Type: <If lang="javascript,nodejs,go">`String`, `StringBuffer`, `JSON Object`</If><If lang="java">`String`, `ByteArray`, `JSONObject`, `JSONArray`</If><If lang="csharp">`String`, `byte[]`, `plain C# object that can be serialized to JSON`</If><If lang="ruby">`String`, `Binary` (ASCII-8BIT String), `Hash`, `Array`</If><If lang="python">`String`, `Bytearray`, `Dict`, `List`</If><If lang="php">`String`, `Binary String`, `Associative Array`, `Array`</If><If lang="objc">`NSString *`, `NSData *`, `NSDictionary *`, `NSArray *`</If><If lang="swift">`String`, `NSData`, `Dictionary`, `Array`</If>_
 
-### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">extras</If><If lang="csharp">Extras</If> <a id="#extras" />
+### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">extras</If><If lang="csharp">Extras</If> <a id="extras" />
 
 Metadata and/or ancillary payloads, if provided. Valid payloads include [`push`](/docs/push/publish#payload), `headers` (a map of strings to strings for arbitrary customer-supplied metadata), [`ephemeral`](/docs/pub-sub/advanced#ephemeral), and [`privileged`](/docs/platform/integrations/webhooks#skipping) objects.<br />_Type: <If lang="java">`JSONObject`, `JSONArray`</If><If lang="csharp">plain C# object that can be converted to JSON</If><If lang="javascript,nodejs">`JSON Object`</If><If lang="ruby">`Hash`, `Array`</If><If lang="python">`Dict`, `List`</If><If lang="swift">`Dictionary`, `Array`</If><If lang="objc">`NSDictionary *`, `NSArray *`</If><If lang="php">`Associative Array`, `Array`</If><If lang="go">`String`, `[]byte`</If>_
 
-### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">id</If><If lang="csharp">Id</If> <a id="#id" />
+### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">id</If><If lang="csharp">Id</If> <a id="id" />
 
 A Unique ID assigned by Ably to this message.<br />_Type: `String`_
 
-### <If lang="javascript,nodejs,php,java,objc,swift,go">clientId</If><If lang="ruby,python">client_id</If><If lang="csharp">ClientId</If> <a id="#client-id" />
+### <If lang="javascript,nodejs,php,java,objc,swift,go">clientId</If><If lang="ruby,python">client_id</If><If lang="csharp">ClientId</If> <a id="client-id" />
 
 The client ID of the publisher of this message.<br />_Type: `String`_
 
-### <If lang="javascript,nodejs,php,java,objc,swift,go">connectionId</If><If lang="ruby,python">connection_id</If><If lang="csharp">ConnectionId</If> <a id="#connection-id" />
+### <If lang="javascript,nodejs,php,java,objc,swift,go">connectionId</If><If lang="ruby,python">connection_id</If><If lang="csharp">ConnectionId</If> <a id="connection-id" />
 
 The connection ID of the publisher of this message.<br />_Type: `String`_
 
-### <If lang="javascript,nodejs,php,java,objc,swift">connectionKey</If><If lang="csharp,go">ConnectionKey</If><If lang="ruby,python">connection_key</If> <a id="#connection-key" />
+### <If lang="javascript,nodejs,php,java,objc,swift">connectionKey</If><If lang="csharp,go">ConnectionKey</If><If lang="ruby,python">connection_key</If> <a id="connection-key" />
 
 A connection key, which can optionally be included for a REST publish as part of the [publishing on behalf of a realtime client functionality](/docs/pub-sub/advanced#publish-on-behalf).<br />_Type: `String`_
 
-### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">timestamp</If><If lang="csharp">Timestamp</If> <a id="#timestamp" />
+### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">timestamp</If><If lang="csharp">Timestamp</If> <a id="timestamp" />
 
 Timestamp when the message was first received by the Ably, as <If lang="javascript,nodejs,php,python,go,java">milliseconds since the epoch</If><If lang="ruby">a `Time` object</If>.<br />_Type: <If lang="javascript,nodejs,php,python">`Integer`</If><If lang="java">`Long Integer`</If><If lang="csharp">`DateTimeOffset`</If><If lang="ruby">`Time`</If><If lang="objc,swift">`NSDate`</If><If lang="go">Integer</If>_
 
-### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">encoding</If><If lang="csharp">Encoding</If> <a id="#encoding" />
+### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">encoding</If><If lang="csharp">Encoding</If> <a id="encoding" />
 
 This will typically be empty as all messages received from Ably are automatically decoded client-side using this value. However, if the message encoding cannot be processed, this attribute will contain the remaining transformations not applied to the `data` payload.<br />_Type: `String`_
 
 <If lang="javascript,nodejs">
 
-### action <a id="#action" />
+### action <a id="action" />
 
 The action type of the message, one of the [`MessageAction`](/docs/api/realtime-sdk/types#message-action) enum values.<br />_Type: `int enum { MESSAGE_CREATE, MESSAGE_UPDATE, MESSAGE_DELETE, META, MESSAGE_SUMMARY }`_
 
-### serial <a id="#serial" />
+### serial <a id="serial" />
 
 A server-assigned identifier that will be the same in all future updates of this message. It  can be used to add annotations to a message. Serial will only be set if you enable annotations in [channel rules](/docs/channels#rules).<br />_Type: `String`_
 
-### annotations <a id="#annotations" />
+### annotations <a id="annotations" />
 
 An object containing information about annotations that have been made to the object.<br />_Type: [`MessageAnnotations`](/docs/api/realtime-sdk/types#message-annotations)_
 
 </If>
 
-### Message constructors <a id="#constructors" />
+### Message constructors <a id="constructors" />
 
-#### Message.fromEncoded <a id="#message-from-encoded" />
+#### Message.fromEncoded <a id="message-from-encoded" />
 
 `Message.fromEncoded(Object encodedMsg, ChannelOptions channelOptions?) -> Message`
 
@@ -349,7 +349,7 @@ A static factory method to create a [`Message`](/docs/api/realtime-sdk/types#mes
 
 A [`Message`](/docs/api/realtime-sdk/types#message) object
 
-#### Message.fromEncodedArray <a id="#message-from-encoded-array" />
+#### Message.fromEncodedArray <a id="message-from-encoded-array" />
 
 `Message.fromEncodedArray(Object[] encodedMsgs, ChannelOptions channelOptions?) -> Message[]`
 
@@ -366,7 +366,7 @@ A static factory method to create an array of [`Messages`](/docs/api/realtime-sd
 
 An `Array` of [`Message`](/docs/api/realtime-sdk/types#message) objects
 
-### <If lang="javascript,nodejs,php,python,go">PresenceMessage</If><If lang="swift,objc">ARTPresenceMessage</If><If lang="ruby">Ably::Models::PresenceMessage Enum</If><If lang="java">io.ably.lib.types.PresenceMessage</If><If lang="csharp">IO.Ably.PresenceMessage</If> <a id="#presence-message" />
+### <If lang="javascript,nodejs,php,python,go">PresenceMessage</If><If lang="swift,objc">ARTPresenceMessage</If><If lang="ruby">Ably::Models::PresenceMessage Enum</If><If lang="java">io.ably.lib.types.PresenceMessage</If><If lang="csharp">IO.Ably.PresenceMessage</If> <a id="presence-message" />
 
 A `PresenceMessage` represents an individual presence update that is sent to or received from Ably.
 
@@ -385,7 +385,7 @@ A `PresenceMessage` represents an individual presence update that is sent to or
 
 ### PresenceMessage constructors
 
-#### PresenceMessage.fromEncoded <a id="#presence-from-encoded" />
+#### PresenceMessage.fromEncoded <a id="presence-from-encoded" />
 
 `PresenceMessage.fromEncoded(Object encodedPresMsg, ChannelOptions channelOptions?) -> PresenceMessage`
 
@@ -402,7 +402,7 @@ A static factory method to create a [`PresenceMessage`](/docs/api/realtime-sdk/t
 
 A [`PresenceMessage`](/docs/api/realtime-sdk/types#presence-message) object
 
-#### PresenceMessage.fromEncodedArray <a id="#presence-from-encoded-array" />
+#### PresenceMessage.fromEncodedArray <a id="presence-from-encoded-array" />
 
 `PresenceMessage.fromEncodedArray(Object[] encodedPresMsgs, ChannelOptions channelOptions?) -> PresenceMessage[]`
 
@@ -419,7 +419,7 @@ A static factory method to create an array of [`PresenceMessages`](/docs/api/rea
 
 An `Array` of [`PresenceMessage`](/docs/api/realtime-sdk/types#presence-message) objects
 
-### <If lang="javascript,nodejs,php,go">Presence action</If><If lang="python">PresenceAction</If><If lang="swift,objc">ARTPresenceAction</If><If lang="java">io.ably.lib.types.PresenceMessage.Action</If><If lang="ruby">Ably::Models::PresenceMessage::ACTION</If><If lang="csharp">IO.Ably.PresenceAction</If> <a id="#presence-action" />
+### <If lang="javascript,nodejs,php,go">Presence action</If><If lang="python">PresenceAction</If><If lang="swift,objc">ARTPresenceAction</If><If lang="java">io.ably.lib.types.PresenceMessage.Action</If><If lang="ruby">Ably::Models::PresenceMessage::ACTION</If><If lang="csharp">IO.Ably.PresenceAction</If> <a id="presence-action" />
 
 <If lang="javascript,nodejs">
 
@@ -639,7 +639,7 @@ const (
 
 <If lang="csharp">
 
-### IO.Ably.PaginatedRequestParams <a id="#paginated-request-params" />
+### IO.Ably.PaginatedRequestParams <a id="paginated-request-params" />
 
 `HistoryRequestParams` is a type that encapsulates the parameters for a history queries. For example usage see [`Channel#History`](/docs/api/realtime-sdk/history#channel-history).
 
@@ -655,7 +655,7 @@ const (
 
 </If>
 
-### <If lang="javascript,nodejs,php,python,go">PaginatedResult</If><If lang="swift,objc">ARTPaginatedResult</If><If lang="ruby">Ably::Models::PaginatedResult</If><If lang="java">io.ably.lib.types.PaginatedResult</If><If lang="csharp">IO.Ably.PaginatedResult</If> <a id="#paginated-result" />
+### <If lang="javascript,nodejs,php,python,go">PaginatedResult</If><If lang="swift,objc">ARTPaginatedResult</If><If lang="ruby">Ably::Models::PaginatedResult</If><If lang="java">io.ably.lib.types.PaginatedResult</If><If lang="csharp">IO.Ably.PaginatedResult</If> <a id="paginated-result" />
 
 A `PaginatedResult` is a type that represents a page of results for all message and presence history, stats and REST presence requests. The response from a [Ably REST API paginated query](/docs/api/rest-api/#pagination) is accompanied by metadata that indicates the relative queries available to the `PaginatedResult` object.
 
@@ -861,15 +861,15 @@ Returns a promise. On success, the promise is fulfilled with a new `PaginatedRes
 </If>
 <If lang="javascript,nodejs">
 
-##### current <a id="#current" />
+##### current <a id="current" />
 
 `current(): Promise<PaginatedResult>`
 
 Returns a promise. On success, the promise is fulfilled with a new `PaginatedResult` loaded with the current page of results. On failure, the promise is rejected with an [`ErrorInfo`](/docs/api/realtime-sdk/types#error-info) object that details the reason why it was rejected.
 
 </If>
 
-#### Example <a id="#paginated-result-example" />
+#### Example <a id="paginated-result-example" />
 
 <If lang="javascript">
 
@@ -1038,7 +1038,7 @@ fmt.Println("Last page? %s\n", page1.IsLast())
 </If>
 <If lang="java">
 
-### io.ably.lib.types.Param <a id="#param" />
+### io.ably.lib.types.Param <a id="param" />
 
 `Param` is a type encapsulating a key/value pair. This type is used frequently in method parameters allowing key/value pairs to be used more flexible, see [`Channel#history`](/docs/api/realtime-sdk/history#channel-history) for an example.
 
