Skip to content

Commit ad4415b

Browse files
m-hulbertVeskeR
authored andcommitted
fixup! Update the rest of JS API references to ably-js v2 - Promises and API
1 parent 862fa35 commit ad4415b

File tree

3 files changed

+8
-12
lines changed

3 files changed

+8
-12
lines changed

content/partials/rest/_request.textile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ h4. Parameters
1818

1919
- method := either @get@, @post@, @put@, @patch@ or @delete@.<br>__Type: <span lang="default">String</span><span lang="go,csharp">string</span>__
2020
- path := the path to query.<br>__Type: <span lang="default">String</span><span lang="go,csharp">string</span>__
21-
blang[jsall].
22-
- version := version of the REST API to use.<br>__Type: Number__
21+
22+
- <div lang="jsall">version</div> := version of the REST API to use.<br>__Type: Number__
2323

2424
- params := (optional) any querystring parameters needed.<br>__Type: <span lang="default">Object</span><span lang="go">PaginateParams</span><span lang="csharp">Dictionary<string, string></span>__
2525
- body := (optional; for @post@, @put@ and @patch@ methods) the body of the request, as <span lang="default">anything that can be serialized into JSON, such as an @Object@ or @Array@.</span><span lang="csharp">a JToken.</span><br>__Type: <span lang="default">Serializable</span><span lang="go">interface</span><span lang="csharp">JToken</span>__

content/partials/types/_local_device.textile

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,10 @@ h4.
99
java: Members
1010
ruby: Attributes
1111

12-
blang[jsall].
13-
- id := a unique ID generated by the device<br>__Type: @String@__
14-
15-
- deviceSecret := a unique device secret generated by the Ably SDK<br>__Type: @String@__
12+
- <div lang="jsall">id</div> := a unique ID generated by the device<br>__Type: @String@__
13+
- <div lang="jsall">deviceSecret</div> := a unique device secret generated by the Ably SDK<br>__Type: @String@__
1614

17-
- <span lang="default">deviceIdentityToken</span> := a unique identity token for the device<br>__Type: @String@__
15+
- deviceIdentityToken := a unique identity token for the device<br>__Type: @String@__
1816

1917
blang[jsall].
2018
h4. Methods

content/partials/types/_push_channel.textile

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<div lang="jsall,java,android,swift,objc">
21
A @PushChannel@ is a property of a "@RealtimeChannel@":/docs/api/realtime-sdk/channels#properties or "@RestChannel@":/docs/api/rest-sdk/channels#properties. It provides "push devices":/docs/push the ability to subscribe and unsubscribe to push notifications on channels.
32

43
h4. Methods
@@ -71,11 +70,11 @@ Lists push subscriptions on a channel specified by its channel name (@channel@).
7170

7271
h4. Parameters
7372

74-
- <div lang="default">deviceId</div> := a deviceId to filter by<br>__Type: @String@__
73+
- deviceId := a deviceId to filter by<br>__Type: @String@__
7574

76-
- <div lang="default">clientId</div> := a clientId to filter by<br>__Type: @String@__
75+
- clientId := a clientId to filter by<br>__Type: @String@__
7776

78-
- <div lang="default">deviceClientId</div> := a client ID associated with a device to filter by<br>__Type: @String@__
77+
- deviceClientId := a client ID associated with a device to filter by<br>__Type: @String@__
7978

8079
- <div lang="swift,objc">callback</div> := called with a "ARTPaginatedResult":#paginated-result<"PushChannelSubscription":/docs/api/realtime-sdk/push-admin#push-channel-subscription> object or an error
8180

@@ -99,4 +98,3 @@ blang[java,android].
9998
On success, the returned "@PaginatedResult@":#paginated-result encapsulates an array of "PushChannelSubscription":#push-channel-subscription objects corresponding to the current page of results. "@PaginatedResult@":#paginated-result supports pagination using "@next@":#paginated-result and "@first@":#paginated-result methods.
10099

101100
Failure to retrieve the message history will raise an "@AblyException@":/docs/api/realtime-sdk/types#ably-exception
102-
</div>

0 commit comments

Comments
 (0)