Skip to content

Commit 7738c92

Browse files
Rename entry point: channel.objects.getRoot() -> channel.object.get(), rename RealtimeObjects -> RealtimeObject
Co-Authored-By: Lawrence Forooghian <lawrence.forooghian@ably.com>
1 parent d389270 commit 7738c92

2 files changed

Lines changed: 48 additions & 43 deletions

File tree

specifications/features.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -377,15 +377,15 @@ Support for the deprecated client options `environment`, `restHost`, `realtimeHo
377377
- `(PC2)` No generic plugin interface is specified, and therefore there is no common API exposed by all plugins. However, for type-safety, the opaque interface `Plugin` should be used in strongly-typed languages as the type of the `ClientOptions.plugins` collection as per [TO3o](#TO3o).
378378
- `(PC3)` A plugin provided with the `PluginType` enum key value of `vcdiff` should be capable of decoding "vcdiff"-encoded messages. It must implement the `VCDiffDecoder` interface and the client library must be able to use it by casting it to this interface.
379379
- `(PC3a)` The base argument of the `VCDiffDecoder.decode` method should receive the stored base payload of the last message on a channel as specified by [RTL19](#RTL19). If the base payload is a string it should be encoded to binary using UTF-8 before being passed as base argument of the `VCDiffDecoder.decode` method.
380-
- `(PC5)` A plugin provided with the `PluginType` enum key value of `Objects` should provide the [RealtimeObjects](../objects-features#RTO1) feature functionality for realtime channels ([RTL27](#RTL27)). The plugin object itself is not expected to provide a public API. The type of the plugin object, and how it enables the Objects feature for a realtime channel, are left for individual implementations to decide.
380+
- `(PC5)` A plugin provided with the `PluginType` enum key value of `LiveObjects` should provide the [RealtimeObject](../objects-features#RTO23) feature functionality for realtime channels ([RTL27](#RTL27)). The plugin object itself is not expected to provide a public API. The type of the plugin object, and how it enables the Objects feature for a realtime channel, are left for individual implementations to decide.
381381
- `(PC4)` A client library is allowed to accept plugins other than those specified in this specification, through the use of additional `ClientOptions.plugins` keys defined by that library. The library is responsible for defining the interface of these plugins, and for making sure that these keys do not clash with the keys defined in this specification.
382382

383383
### PluginType {#plugin-type}
384384

385385
- `(PT1)` `PluginType` is an enum describing the different types of plugins that the library supports. See the `ClientOptions#plugins` property ([TO3o](#TO3o)).
386386
- `(PT2)` `PluginType` takes one of the following values:
387387
- `(PT2a)` `vcdiff` -- see [PC3](#PC3).
388-
- `(PT2b)` `Objects` -- see [PC5](#PC5).
388+
- `(PT2b)` `LiveObjects` -- see [PC5](#PC5).
389389

390390
### VCDiffDecoder {#vcdiff-decoder}
391391

@@ -673,7 +673,7 @@ The threading and/or asynchronous model for each realtime library will vary by l
673673
### RealtimeChannel {#realtime-channel}
674674

675675
- `(RTL23)` `RealtimeChannel#name` attribute is a string containing the channel's name
676-
- `(RTL1)` As soon as a `RealtimeChannel` becomes attached, all incoming messages, presence messages and object messages (where 'incoming' is defined as 'received from Ably over the realtime transport') are processed and emitted where applicable. `PRESENCE` and `SYNC` messages are passed to the `RealtimePresence` object ensuring it maintains a map of current members on a channel in realtime. `OBJECT` and `OBJECT_SYNC` messages are passed to the `RealtimeObjects` object ensuring it maintains an up-to-date representation of objects on a channel in realtime
676+
- `(RTL1)` As soon as a `RealtimeChannel` becomes attached, all incoming messages, presence messages and object messages (where 'incoming' is defined as 'received from Ably over the realtime transport') are processed and emitted where applicable. `PRESENCE` and `SYNC` messages are passed to the `RealtimePresence` object ensuring it maintains a map of current members on a channel in realtime. `OBJECT` and `OBJECT_SYNC` messages are passed to the `RealtimeObject` object ensuring it maintains an up-to-date representation of objects on a channel in realtime
677677
- `(RTL2)` The `RealtimeChannel` implements `EventEmitter` and emits `ChannelEvent` events, where a `ChannelEvent` is either a `ChannelState` or `UPDATE`, and a `ChannelState` is either `INITIALIZED`, `ATTACHING`, `ATTACHED`, `DETACHING`, `DETACHED`, `SUSPENDED` and `FAILED`
678678
- `(RTL2a)` It emits a `ChannelState` `ChannelEvent` for every channel state change
679679
- `(RTL2g)` It emits an `UPDATE` `ChannelEvent` for changes to channel conditions for which the `ChannelState` (e.g. `ATTACHED`) does not change, unless explicitly prevented by a more specific condition (see [RTL12](#RTL12)). (The library must never emit a `ChannelState` `ChannelEvent` for a state equal to the previous state)
@@ -767,9 +767,9 @@ The threading and/or asynchronous model for each realtime library will vary by l
767767
- `(RTL8b)` Unsubscribe with a name argument and a listener argument unsubscribes the provided listener if previously subscribed with a name-specific subscription
768768
- `(RTL9)` `RealtimeChannel#presence` attribute:
769769
- `(RTL9a)` Returns the `RealtimePresence` object for this channel
770-
- `(RTL27)` `RealtimeChannel#objects` attribute:
771-
- `(RTL27a)` Returns the `RealtimeObjects` object for this channel [RTO1](../objects-features#RTO1)
772-
- `(RTL27b)` It is a programmer error to access this property without first providing the `Objects` plugin ([PC5](#PC5)) in the client options. This programmer error should be handled in an idiomatic fashion; if this means accessing the property should throw an error, then the error should be an `ErrorInfo` with `statusCode` 400 and `code` 40019.
770+
- `(RTL27)` `RealtimeChannel#object` attribute:
771+
- `(RTL27a)` Returns the `RealtimeObject` object for this channel [RTO23](../objects-features#RTO23)
772+
- `(RTL27b)` It is a programmer error to access this property without first providing the `LiveObjects` plugin ([PC5](#PC5)) in the client options. This programmer error should be handled in an idiomatic fashion; if this means accessing the property should throw an error, then the error should be an `ErrorInfo` with `statusCode` 400 and `code` 40019.
773773
- `(RTL10)` `RealtimeChannel#history` function:
774774
- `(RTL10a)` Supports all the same params as `RestChannel#history`
775775
- `(RTL10b)` Additionally supports the param `untilAttach`, which if true, will only retrieve messages prior to the moment that the channel was attached or emitted an `UPDATE` indicating loss of continuity. This bound is specified by passing the querystring param `fromSerial` with the `RealtimeChannel#properties.attachSerial` assigned to the channel in the `ATTACHED` `ProtocolMessage` (see [RTL15a](#RTL15a)). If the `untilAttach` param is specified when the channel is not attached, it results in an error
@@ -937,9 +937,9 @@ The threading and/or asynchronous model for each realtime library will vary by l
937937
- `(RTP15e)` Implicitly attaches the `RealtimeChannel` if the channel is in the `INITIALIZED` state. However, if the channel is in or enters the `DETACHED` or `FAILED` state before the operation succeeds, it will result in an error
938938
- `(RTP15f)` If the client is identified and has a valid `clientId`, and the `clientId` argument does not match the client's `clientId`, then it should indicate an error. The connection and channel remain available for further operations
939939

940-
### RealtimeObjects {#realtime-objects}
940+
### RealtimeObject {#realtime-objects}
941941

942-
Reserved for `RealtimeObjects` feature specification, see [objects-features](../objects-features). Reserved spec points: `RTO`, `RTLO`, `RTLC`, `RTLM`
942+
Reserved for `RealtimeObject` feature specification, see [objects-features](../objects-features). Reserved spec points: `RTO`, `RTLO`, `RTLC`, `RTLM`
943943

944944
### RealtimeAnnotations {#realtime-annotations}
945945

@@ -2258,7 +2258,7 @@ Each type, method, and attribute is labelled with the name of one or more clause
22582258
state: ChannelState // RTL2b
22592259
whenState(ChannelState, (ChannelStateChange?) ->) // RTL25
22602260
presence: RealtimePresence // RTL9
2261-
objects: RealtimeObjects // RTL27
2261+
object: RealtimeObject // RTL27
22622262
properties: ChannelProperties // RTL15
22632263
// Only on platforms that support receiving push notifications:
22642264
push: PushChannel // RSH7
@@ -2838,7 +2838,7 @@ Each type, method, and attribute is labelled with the name of one or more clause
28382838

28392839
enum PluginType // PT*
28402840
"vcdiff" // PT2a
2841-
"Objects" // PT2b
2841+
"LiveObjects" // PT2b
28422842

28432843
class VCDiffDecoder // VD*
28442844
decode([byte] delta, [byte] base) -> [byte] // VD2a, PC3a

0 commit comments

Comments
 (0)