Skip to content

Consider renaming or changing visibility of PublicDefaultRealtimeObjects class #40

@coderabbitai

Description

@coderabbitai

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 internal but 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/objects property, 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

  1. Rename the class to something like DefaultRealtimeObjects or InternalRealtimeObjectsProxy to better reflect its internal nature
  2. Change the visibility to public if it should indeed be part of the public API
  3. Update the documentation to clarify the distinction between "public API functionality" and "public visibility"

References

┆Issue is synchronized with this Jira Task by Unito

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions