Update JS API refs from callbacks to promises

Author: m-hulbert

content/api/realtime-sdk.textile

@@ -3,7 +3,6 @@ title: Constructor
 meta_description: "Realtime Client Library SDK API reference section for the constructor object."
 meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, constructor, instantiate"
 section: api
-index: 1
 languages:
   - javascript
   - nodejs
@@ -13,37 +12,12 @@ languages:
   - objc
   - csharp
   - flutter
-jump_to:
-  Constructor object:
-    - constructor
-  Attributes:
-    - auth
-    - channels
-    - client_id#client-id
-    - connection
-    - rest_client#rest-client
-  Methods:
-    - connect
-    - close
-    - stats
-    - time
-    - request
-  Related Types:
-    - ClientOptions#client-options
-    - stats#stats-type
-    - HttpPaginatedResponse#http-paginated-response
 redirect_from:
   - /docs/api/versions/v1.1/realtime-sdk
   - /docs/api/versions/v1.0/realtime-sdk
   - /docs/api/versions/v0.8/realtime-sdk
 ---
 
-blang[javascript,nodejs].
-
-  <aside data-type='note'>
-  <p>This API reference is for version 1.2 of the JavaScript SDK. Version 2.0 references are "available in TypeDoc.":https://ably.com/docs/sdk/js/v2.0/</p>
-  </aside>
-
 h2(#constructor). Constructor
 
 The Ably Realtime library constructor is overloaded allowing it to be instantiated using a "@ClientOptions@":#client-options object, or more simply using a string containing an "API key":/docs/auth/basic or "Token":/docs/auth/token, as shown below:
@@ -191,6 +165,7 @@ h6(#stats).
 
 bq(definition).
   default: stats(Object options, callback("ErrorInfo":/docs/api/realtime-sdk/types#error-info err, "PaginatedResult":/docs/api/realtime-sdk/types#paginated-result<"Stats":#stats> results))
+  jsall: stats(params?): Promise<"PaginatedResult":/docs/api/realtime-sdk/types#paginated-result<"Stats":#stats>>
   ruby:    "Deferrable":/docs/api/realtime-sdk/types#deferrable stats(Hash options) -> yields "PaginatedResult":/docs/api/realtime-sdk/types#paginated-result<"Stats":#stats>
   java:    "PaginatedResult":/docs/api/realtime-sdk/types#paginated-result<"Stats":#stats> stats("Param":#param[] options)
   swift,objc: stats(query: ARTStatsQuery?, callback: ("ARTPaginatedResult":/docs/api/realtime-sdk/types#paginated-result<"ARTStats":/docs/api/realtime-sdk/types#stats>?, ARTErrorInfo?) -> Void) throws
@@ -208,14 +183,20 @@ h6(#time).
 
 bq(definition).
   default: time(callback("ErrorInfo":/docs/api/realtime-sdk/types#error-info err, Number time))
+  jsall: time(): Promise<Number>
   ruby:   "Deferrable":/docs/api/realtime-sdk/types#deferrable time -> yields Time
   java:   long time()
   csharp: Task<DateTimeOffset> TimeAsync()
   objc,swift: time(callback: (NSDate?, NSError?) -> Void)
 
 Obtains the time from the Ably service as <span lang="ruby">a @Time@ object</span><span lang="csharp">a @DateTimeOffset@ object</span><span lang="default">milliseconds since epoch</span>. (Clients that do not have access to a sufficiently well maintained time source and wish to issue Ably "TokenRequests":/docs/api/realtime-sdk/authentication#token-request with a more accurate timestamp should use the @queryTime@ "clientOptions":#client-options instead of this method).
 
-blang[jsall,objc,swift].
+blang[jsall].
+  h4. Returns
+
+  Returns a promise. On success, the promise is fulfilled with the time as milliseconds since the Unix epoch. On failure, the promise is rejected with an "@ErrorInfo@":/api/realtime-sdk/types#error-info object.
+
+blang[objc,swift].
   h4. Callback result
 
   On success, @time@ is a number containing the number of milliseconds since the epoch.
@@ -238,7 +219,6 @@ blang[csharp].
 
   Failure to retrieve the Ably server time will raise an "@AblyException@":#ably-exception.
 
-
 blang[ruby].
   h4. Returns
 
@@ -250,6 +230,45 @@ blang[ruby].
 
 <%= partial partial_version('rest/_request') %>
 
+blang[javascript].
+  h6(#batchPublish). batchPublish
+
+  There are two overloaded versions of this method:
+
+  bq(definition#batchPublish).
+    default:  batchPublish(spec): Promise<BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>>
+
+  Publishes a "@BatchPublishSpec@":LINK object to one or more channels, up to a maximum of 100 channels.
+
+  bq(definition#batchPublishArray).
+    default:  batchPublish(specs): Promise<BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>[]>
+
+  Publishes one or more "@BatchPublishSpec@":LINK objects to one or more channels, up to a maximum of 100 channels.
+
+  h4. Parameters
+
+  - spec := an object describing the messages to be batch published and to which channels<br>__Type: "@BatchPublishSpec@":LINK__
+  - specs := an array of objects describing the messages to be batch published and to which channels<br>__Type: "@BatchPublishSpec@[]":LINK__
+
+  h4. Returns
+
+  Returns a promise. On success, the promise is fulfilled with a "@BatchResult@":/LINK object, or an array of @BatchResult@ objects, containing information about the result of the batch publish operation for each channel. The successful results of specific channels are returned as "@BatchPublishSuccessResult@":/LINK objects, whilst failures are "@BatchPublishFailureResult@":/LINK objects. If an array of @BatchResult@ objects are returned, they are in the same order as the provided "@BatchPublishSpec@":/LINK. On failure, the promise is rejected with an "@ErrorInfo@":/api/realtime-sdk/types#error-info object.
+
+  h6(#batchPresence). batchPresence
+
+  bq(definition#batchPresence).
+    default: batchPresence(channels): Promise<BatchResult<BatchPresenceSuccessResult | BatchPresenceFailureResult>[]>
+
+  Retrieves the presence state for one or more channels, up to a maximum of 100 channels. Presence state includes the "@clientId@":#client-options of members and their current "@PresenceAction@":/api/realtime-sdk/presence#presence-action
+
+  h4. Parameters
+
+  - channels := an array of one or more channel names, up to a maximum of 100 channels<br>__Type: @String[]@__
+
+  h4. Returns
+
+  Returns a promise. On success, the promise is fulfilled with a "@BatchResult@":/LINK object containing information about the result of the batch presence request for each channel. The successful results of specific channels are returned as "@BatchPresenceSuccessResult@":/LINK objects, whilst failures are "@BatchPresenceFailureResult@":/LINK objects. On failure, the promise is rejected with an "@ErrorInfo@":/api/realtime-sdk/types#error-info object.
+
 h2(#related-types). Related types
 
 h3(#client-options).

content/api/realtime-sdk/channel-metadata.textile

@@ -3,23 +3,11 @@ title: Channel Metadata
 meta_description: "Realtime Client Library SDK API reference section for channel metadata."
 meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, channel, metadata, channel metadata, occupancy"
 section: api
-index: 25
-jump_to:
-  Channel API Types:
-    - ChannelDetails#channel-details
-    - ChannelStatus#channel-status
-    - Occupancy#occupancy
 redirect_from:
   - /docs/api/versions/v1.1/realtime-sdk/channel-metadata
   - /docs/api/versions/v1.0/realtime-sdk/channel-metadata
 ---
 
-blang[javascript,nodejs].
-
-  <aside data-type='note'>
-  <p>This API reference is for version 1.2 of the JavaScript SDK. Version 2.0 references are "available in TypeDoc.":https://ably.com/docs/sdk/js/v2.0/</p>
-  </aside>
-
 h2(#types). Types
 
 The payload of metadata events for channels is the "@ChannelDetails@":#channel-details type which contains the @channelId@ and other static information about the channel, plus a @status@ containing a "@ChannelStatus@":#channel-status instance which contains information about the current state of the channel.