Feedback from customer re private methods

[SimonWoolf]

Feedback from a customer that: "there are lots of undocumented functions (which ones can I safely use? Nothing is private.". Matt mentioned they need to send messages to each other; customer replied that that "has been solved with Objective-C using private headers, and it has been solved in Swift with "internal" and "fileprivate" attribute on functions/classes."

[tcard]

We do keep separate public and private headers. I'm not sure how the customer get access to the private headers. From a fresh Xcode project and installing Ably normally I can only see the public API.

[ricardopereira]

Yes, we keep it separated but maybe the customer is adding the lib manually. @SimonWoolf Can you confirm that is the case?

[ricardopereira]

Using lib with CocoaPods
Showing only what's public.

[danielrhodes]

I'm not sure if any of these are supposed to be private, but some of them don't seem to be listed on your documentation.

[tcard]

@danielrhodes Thanks. All of those are correctly public. ARTRealtimeChannel is described here (make sure you select Swift at the top-right) and ARTRealtimeChannels isn't really in the documentation proper but it is in our thorough API spec that all our client libraries implement.

We really could do a better job mapping in-library documentation to the docs, though! So thanks for bringing this into our attention. We'll definitely work to improve this.

[tcard]

Closing as we're tracking this issue specifically somewhere else now.