You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This call queries the "REST @/stats@ API":/docs/api/rest-api#stats and retrieves your application's usage statistics. A "PaginatedResult":/docs/api/realtime-sdk/types#paginated-result is returned, containing an array of "Stats":#stats for the first page of results. "PaginatedResult":/docs/api/realtime-sdk/types#paginated-result objects are iterable providing a means to page through historical statistics. "See an example set of raw stats returned via the REST API":/docs/metadata-stats/stats#metrics.
174
+
This call queries the "REST @/stats@ API":/docs/api/rest-api#stats and retrieves your application's usage statistics. A "PaginatedResult":/docs/api/realtime-sdk/types#paginated-result is returned, containing an array of "Stats":#stats-type for the first page of results. "PaginatedResult":/docs/api/realtime-sdk/types#paginated-result objects are iterable providing a means to page through historical statistics. "See an example set of raw stats returned via the REST API":/docs/metadata-stats/stats#metrics.
175
175
176
176
See "statistics":/docs/metadata-stats/stats for more information.
177
177
@@ -183,18 +183,18 @@ h6(#time).
183
183
184
184
bq(definition).
185
185
default: time(callback("ErrorInfo":/docs/api/realtime-sdk/types#error-info err, Number time))
186
-
jsall: time(): Promise<Number>
187
-
ruby: "Deferrable":/docs/api/realtime-sdk/types#deferrable time -> yields Time
188
-
java: long time()
189
-
csharp: Task<DateTimeOffset> TimeAsync()
186
+
jsall: time(): Promise<Number>
187
+
ruby: "Deferrable":/docs/api/realtime-sdk/types#deferrable time -> yields Time
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).
193
193
194
194
blang[jsall].
195
195
h4. Returns
196
196
197
-
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.
197
+
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@":/docs/api/realtime-sdk/types#error-info object.
Publishes one or more "@BatchPublishSpec@":LINK objects to one or more channels, up to a maximum of 100 channels.
246
+
Publishes one or more "@BatchPublishSpec@":#batch-publish-spec objects to one or more channels, up to a maximum of 100 channels.
247
247
248
248
h4. Parameters
249
249
250
-
- spec := an object describing the messages to be batch published and to which channels<br>__Type: "@BatchPublishSpec@":LINK__
251
-
- specs := an array of objects describing the messages to be batch published and to which channels<br>__Type: "@BatchPublishSpec@[]":LINK__
250
+
- spec := an object describing the messages to be batch published and to which channels<br>__Type: "@BatchPublishSpec@":#batch-publish-spec
251
+
- specs := an array of objects describing the messages to be batch published and to which channels<br>__Type: "@BatchPublishSpec@[]":#batch-publish-spec
252
252
253
253
h4. Returns
254
254
255
-
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.
255
+
Returns a promise. On success, the promise is fulfilled with a "@BatchResult@":#batch-result object, or an array of "@BatchResult@":#batch-result objects, containing information about the result of the batch publish operation for each channel. The successful results of specific channels are returned as "@BatchPublishSuccessResult@":#batch-publish-success-result objects, whilst failures are "@BatchPublishFailureResult@":#batch-publish-failure-result objects. If an array of "@BatchResult@":#batch-result objects are returned, they are in the same order as the provided "@BatchPublishSpec@":#batch-publish-spec. On failure, the promise is rejected with an "@ErrorInfo@":/docs/api/realtime-sdk/types#error-info object.
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
262
+
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@":/docs/api/realtime-sdk/presence#presence-action.
263
263
264
264
h4. Parameters
265
265
266
266
- channels := an array of one or more channel names, up to a maximum of 100 channels<br>__Type: @String[]@__
267
267
268
268
h4. Returns
269
269
270
-
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.
270
+
Returns a promise. On success, the promise is fulfilled with a "@BatchResult@":#batch-result object containing information about the result of the batch presence request for each channel. The successful results of specific channels are returned as "@BatchPresenceSuccessResult@":#batch-presence-success-result objects, whilst failures are "@BatchPresenceFailureResult@":#batch-presence-failure-result objects. On failure, the promise is rejected with an "@ErrorInfo@":/docs/api/realtime-sdk/types#error-info object.
0 commit comments