-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Description
Issue Description
The PublicDefaultRealtimeObjects class in Sources/AblyLiveObjects/Public/Public Proxy Objects/PublicDefaultRealtimeObjects.swift has potentially confusing naming and visibility:
- The class is marked as
internalbut serves as the public API for interacting with LiveObjects - The name suggests it should be public, but it's actually an internal implementation detail that users don't directly see
- Users interact with this class through the
ARTRealtimeChannel/objectsproperty, but the class itself is not part of the public API surface
Context
This was discussed in PR #26 where the class documentation states it "provides the public API for interacting with LiveObjects" but the class visibility is internal.
Potential Solutions
- Rename the class to something like
DefaultRealtimeObjectsorInternalRealtimeObjectsProxyto better reflect its internal nature - Change the visibility to
publicif it should indeed be part of the public API - Update the documentation to clarify the distinction between "public API functionality" and "public visibility"
References
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels