Docs/docs(ios): Add sample payloads and fix API signatures in iOS SDK & UIKit documentation#266
Open
aryakulkarni-cometchat wants to merge 3 commits intomainfrom
Open
Docs/docs(ios): Add sample payloads and fix API signatures in iOS SDK & UIKit documentation#266aryakulkarni-cometchat wants to merge 3 commits intomainfrom
aryakulkarni-cometchat wants to merge 3 commits intomainfrom
Conversation
…documentation - Added JSON response payloads to 51 iOS SDK documentation files - Fixed API method signatures: - retrieve-conversations.mdx: Changed .set(conversationType:) to .setConversationType(conversationType:) - retrieve-groups.mdx: Fixed getGroup callback to use non-optional Group return type Files updated: authentication, users, groups, messaging, calling, push notifications, AI features, delegates
- Fixed logout method signature: CometChatUIKit.logout(onSuccess:onError:) → CometChatUIKit.logout(user:result:) - Fixed Users component methods: set(trailView:) → set(trailingView:), set(subtitleView:) → set(subtitle:) - Fixed Groups component methods: set(trailView:) → set(trailingView:), SetSubTitleView → set(subtitle:) - Added Quick Reference sections for AI Agents All changes verified against actual SDK source code.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR enhances the iOS SDK and UIKit documentation with comprehensive sample payloads and fixes incorrect API method signatures discovered during sample app development.
Changes
iOS SDK Documentation (51 files)
Sample Payloads Added:
API Signature Fixes:
retrieve-conversations.mdx: Changed.set(conversationType:)to.setConversationType(conversationType:)retrieve-groups.mdx: FixedgetGroupcallback to use non-optionalGroupreturn typeCategories Updated:
iOS UIKit Documentation (2 files)
Method Signature Fixes in
methods.mdx:CometChatUIKit.logout(onSuccess:onError:)→CometChatUIKit.logout(user:result:)Method Signature Fixes in
property-changes.mdx:set(trailView:)→set(trailingView:)set(subtitleView:)→set(subtitle:)set(trailView:)→set(trailingView:)SetSubTitleView→set(subtitle:)Enhancements:
Verification
All changes verified against actual CometChat iOS SDK source code and tested with a complete sample application that builds and runs successfully.
Files Changed
sdk/ios/ui-kit/ios/