Skip to content

Commit 4ff64ba

Browse files
committed
fixup! Migrate REST SDK API spec History page to MDX
1 parent 2c2b9e8 commit 4ff64ba

File tree

1 file changed

+29
-19
lines changed

1 file changed

+29
-19
lines changed

src/pages/docs/api/rest-sdk/history.mdx

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,37 +24,37 @@ The [Rest `Channel` object](/docs/channels) exposes the following public method
2424

2525
<If lang="javascript,nodejs">
2626

27-
`history(Object params?): Promise<PaginatedResult\<Message>>`
27+
`history(Object params?): Promise<PaginatedResult<Message>>`
2828

2929
</If>
3030
<If lang="ruby">
3131

32-
`PaginatedResult\<Message> history(Hash option)`
32+
`PaginatedResult<Message> history(Hash option)`
3333

3434
</If>
3535
<If lang="python">
3636

37-
`PaginatedResult\<Message> history(kwargs_options)`
37+
`PaginatedResult<Message> history(kwargs_options)`
3838

3939
</If>
4040
<If lang="php">
4141

42-
`PaginatedResult\<Message> history(Array option)`
42+
`PaginatedResult<Message> history(Array option)`
4343

4444
</If>
4545
<If lang="java">
4646

47-
`PaginatedResult\<Message> history(Param[] option)`
47+
`PaginatedResult<Message> history(Param[] option)`
4848

4949
</If>
5050
<If lang="csharp">
5151

52-
`Task<PaginatedResult\<Message>> HistoryAsync(PaginatedRequestParams query);`
52+
`Task<PaginatedResult<Message>> HistoryAsync(PaginatedRequestParams query);`
5353

5454
</If>
5555
<If lang="swift,objc">
5656

57-
`history(query: ARTDataQuery?, callback: (ARTPaginatedResult\<ARTMessage>?, ARTErrorInfo?) -> Void) throws`
57+
`history(query: ARTDataQuery?, callback: (ARTPaginatedResult<ARTMessage>?, ARTErrorInfo?) -> Void) throws`
5858

5959
</If>
6060
<If lang="go">
@@ -67,15 +67,20 @@ Gets a [paginated](#paginated-result) set of historical messages for this channe
6767

6868
#### Parameters
6969

70+
<If lang="javascript,nodejs,java,csharp,php,python,ruby,go">
71+
7072
| Parameter | Description | Type |
7173
|-----------|-------------|------|
72-
| <If lang="javascript,nodejs">params</If><If lang="objc,swift,csharp">query</If><If lang="java">[`Param[]`](#param) option</If><If lang="php,python,ruby,go">option</If> | <If lang="javascript,nodejs">an optional object containing the query parameters</If><If lang="python">optional keyword arguments containing the query parameters</If><If lang="ruby">an optional set of key value pairs containing the query parameters</If><If lang="php">an Associate Array containing the query parameters</If><If lang="java,csharp,objc,swift,go">an optional object containing the query parameters</If>, as specified below. | <If lang="javascript,nodejs">Object</If><If lang="java">[`Param[]`](#param)</If><If lang="csharp">[`PaginatedRequestParams`](#paginated-request-params)</If><If lang="objc,swift">ARTDataQuery</If><If lang="php,python,ruby,go">Object</If> |
74+
| <If lang="javascript,nodejs">params</If><If lang="csharp">query</If><If lang="java">option</If><If lang="php,python,ruby,go">option</If> | <If lang="javascript,nodejs">an optional object containing the query parameters</If><If lang="python">optional keyword arguments containing the query parameters</If><If lang="ruby">an optional set of key value pairs containing the query parameters</If><If lang="php">an Associate Array containing the query parameters</If><If lang="java,csharp,go">an optional object containing the query parameters</If>, as specified below. | <If lang="javascript,nodejs">Object</If><If lang="java">[`Param[]`](#param)</If><If lang="csharp">[`PaginatedRequestParams`](#paginated-request-params)</If><If lang="php,python,ruby,go">Object</If> |
75+
76+
</If>
7377

7478
<If lang="swift,objc">
7579

7680
| Parameter | Description | Type |
7781
|-----------|-------------|------|
78-
| callback | called with a [`ARTPaginatedResult`](#paginated-result)\<[`ARTMessage`](#message)> object or an error | Callback |
82+
| query | an optional object containing the query parameters, as specified below. | ARTDataQuery |
83+
| callback | called with a [`ARTPaginatedResult`](#paginated-result)[`<ARTMessage>`](#message) object or an error | Callback |
7984

8085
</If>
8186

@@ -148,37 +153,37 @@ Failure to retrieve the message history will raise an [`AblyException`](/docs/ap
148153

149154
<If lang="javascript,nodejs">
150155

151-
`history(Object params?): Promise<PaginatedResult\<PresenceMessage>>`
156+
`history(Object params?): Promise<PaginatedResult<PresenceMessage>>`
152157

153158
</If>
154159
<If lang="ruby">
155160

156-
`PaginatedResult\<PresenceMessage> history(Hash option)`
161+
`PaginatedResult<PresenceMessage> history(Hash option)`
157162

158163
</If>
159164
<If lang="python">
160165

161-
`PaginatedResult\<PresenceMessage> history(kwargs_options)`
166+
`PaginatedResult<PresenceMessage> history(kwargs_options)`
162167

163168
</If>
164169
<If lang="php">
165170

166-
`PaginatedResult\<PresenceMessage> history(Array option)`
171+
`PaginatedResult<PresenceMessage> history(Array option)`
167172

168173
</If>
169174
<If lang="java">
170175

171-
`PaginatedResult\<PresenceMessage> history(Param[] option)`
176+
`PaginatedResult<PresenceMessage> history(Param[] option)`
172177

173178
</If>
174179
<If lang="csharp">
175180

176-
`Task<PaginatedResult\<PresenceMessage>> HistoryAsync(PaginatedRequestParams query);`
181+
`Task<PaginatedResult<PresenceMessage>> HistoryAsync(PaginatedRequestParams query);`
177182

178183
</If>
179184
<If lang="swift,objc">
180185

181-
`history(query: ARTDataQuery?, callback: (ARTPaginatedResult\<ARTPresenceMessage>?, ARTErrorInfo?) -> Void) throws`
186+
`history(query: ARTDataQuery?, callback: (ARTPaginatedResult<ARTPresenceMessage>?, ARTErrorInfo?) -> Void) throws`
182187

183188
</If>
184189
<If lang="go">
@@ -191,15 +196,20 @@ Gets a [paginated](#paginated-result) set of historical presence events for this
191196

192197
#### Parameters
193198

199+
<If lang="javascript,nodejs,java,csharp,php,python,ruby,go">
200+
194201
| Parameter | Description | Type |
195202
|-----------|-------------|------|
196-
| <If lang="javascript,nodejs">params</If><If lang="java">[`Param[]`](#param) option</If><If lang="csharp">[`PaginatedRequestParams`](#paginated-request-params) query</If><If lang="php,python,ruby,go">option</If><If lang="objc,swift">query</If> | <If lang="javascript,nodejs,java,csharp,go">an optional object containing the query parameters</If><If lang="python">optional keyword arguments containing the query parameters</If><If lang="ruby">an optional set of key value pairs containing the query parameters</If><If lang="php">an Associate Array containing the query parameters</If><If lang="objc,swift">an optional object containing query parameters</If>, as specified below. | <If lang="javascript,nodejs">Object</If><If lang="java">[`Param[]`](#param)</If><If lang="csharp">[`PaginatedRequestParams`](#paginated-request-params)</If><If lang="objc,swift">ARTDataQuery</If><If lang="php,python,ruby,go">Object</If> |
203+
| <If lang="javascript,nodejs">params</If><If lang="java">option</If><If lang="csharp">[`PaginatedRequestParams`](#paginated-request-params) query</If><If lang="php,python,ruby,go">option</If> | <If lang="javascript,nodejs,java,csharp,go">an optional object containing the query parameters</If><If lang="python">optional keyword arguments containing the query parameters</If><If lang="ruby">an optional set of key value pairs containing the query parameters</If><If lang="php">an Associate Array containing the query parameters</If>, as specified below. | <If lang="javascript,nodejs">Object</If><If lang="java">[`Param[]`](#param)</If><If lang="csharp">[`PaginatedRequestParams`](#paginated-request-params)</If><If lang="php,python,ruby,go">Object</If> |
204+
205+
</If>
197206

198207
<If lang="swift,objc">
199208

200209
| Parameter | Description | Type |
201210
|-----------|-------------|------|
202-
| callback | called with a [`ARTPaginatedResult`](#paginated-result)\<[`ARTPresenceMessage`](#presence-message)> object or an error | Callback |
211+
| query | an optional object containing query parameters, as specified below. | ARTDataQuery |
212+
| callback | called with a [`ARTPaginatedResult`](#paginated-result)[`<ARTPresenceMessage>`](#presence-message) object or an error | Callback |
203213

204214
</If>
205215

@@ -268,7 +278,7 @@ Failure to retrieve the presence event history will raise an [`AblyException`](/
268278

269279
A `Message` represents an individual message that is sent to or received from Ably.
270280

271-
### <If lang="javascript,nodejs,php,python,go,ruby">name</If><If lang="csharp">Name</If> <a id="#name" />
281+
### <If lang="javascript,nodejs,php,python,go,ruby,java,objc,swift">name</If><If lang="csharp">Name</If> <a id="#name" />
272282

273283
The event name, if provided. <br />_Type: `String`_
274284

0 commit comments

Comments
 (0)