fix(ios-uikit): Correct method signatures in iOS UIKit documentation#243
Open
aryakulkarni-cometchat wants to merge 8 commits intomainfrom
Open
fix(ios-uikit): Correct method signatures in iOS UIKit documentation#243aryakulkarni-cometchat wants to merge 8 commits intomainfrom
aryakulkarni-cometchat wants to merge 8 commits intomainfrom
Conversation
- Fixed logout method signature in Quick Reference: Changed from CometChatUIKit.logout(onSuccess:onError:) to CometChatUIKit.logout(user:result:) - Fixed Users component method names in property-changes.mdx: Changed set(trailView:) to set(trailingView:) Changed set(subtitleView:) to set(subtitle:) - Fixed Groups component method names in property-changes.mdx: Changed set(trailView:) to set(trailingView:) Changed SetSubTitleView to set(subtitle:) - Added DOCUMENTATION_REVIEW_REPORT.md with complete verification details All changes verified against actual SDK source code and tested with a complete sample application that builds and runs successfully.
…it docs Added TL;DR Quick Reference sections at the top of all iOS UIKit documentation pages to improve AI agent and developer experience. Each section includes: - Key class names and imports - Essential method signatures with correct parameters - Common usage patterns and code snippets - Links to related documentation - Important warnings about initialization order and auth keys Files updated: - overview.mdx, getting-started.mdx, components-overview.mdx - conversations.mdx, users.mdx, groups.mdx, call-logs.mdx - message-header.mdx, message-list.mdx, message-composer.mdx - All guide files, call features, extensions, and v2/v3/v4 docs This makes the documentation more accessible for AI-assisted development and provides quick reference for experienced developers.
…/failure responses - Add Quick Reference sections to all 94 iOS SDK documentation files - Add complete BaseMessage, User, Group, Conversation property documentation - Add success/failure response examples with actual return types - Add common error codes reference table - Add SDK_DOCUMENTATION_REVIEW_REPORT.md with complete verification details - Document all enum values (ReceiverType, MessageType, UserStatus, etc.) - Add data model sections to overview pages (messaging, users, groups, conversations) This ensures any AI or developer can build a complete working app by following only the documentation.
Added collapsible Sample Payloads accordions with Request, Success Response, and Error Response tabs to the following iOS SDK documentation files: - block-users.mdx (blockUsers, unblockUsers) - create-group.mdx (createGroup, createGroupWithMembers) - delete-conversation.mdx (deleteConversation) - delete-group.mdx (deleteGroup) - delete-message.mdx (deleteMessage) - delivery-read-receipts.mdx (markAsDelivered, markAsRead, getMessageReceipts) - edit-message.mdx (editMessage) - flag-message.mdx (flagMessage) - group-add-members.mdx (addMembersToGroup) - group-change-member-scope.mdx (changeMemberScope) - group-kick-member.mdx (kickGroupMember) - join-group.mdx (joinGroup) - leave-group.mdx (leaveGroup) - mentions.mdx (mentionsWithTagInfo) - reactions.mdx (addReaction, removeReaction) - receive-message.mdx (onTextMessageReceived) - retrieve-conversations.mdx (getConversation, fetchNext) - retrieve-group-members.mdx (GroupMembersRequest.fetchNext) - retrieve-groups.mdx (getGroup, fetchNext) - retrieve-users.mdx (getUser, fetchNext) - send-message.mdx (sendTextMessage) - threaded-messages.mdx (sendMessageInThread) - transfer-group-ownership.mdx (transferOwnership) - transient-messages.mdx (sendTransientMessage) - typing-indicators.mdx (startTyping, endTyping) - update-group.mdx (updateGroup) - user-management.mdx (updateUser) - user-presence.mdx (subscribeToUserPresence)
Fixed inconsistent parameter naming in login code examples: - Changed apiKey to authKey to match actual SDK method signature - Fixed Swift comment syntax (__ to //) - Fixed escaped characters in string interpolation
- sdk/ios/retrieve-conversations.mdx: - Changed .set(conversationType:) to .setConversationType(conversationType:) - Fixed 5 occurrences in Quick Reference and code examples - Aligns with actual CometChat iOS SDK API - sdk/ios/retrieve-groups.mdx: - Fixed getGroup callback to use non-optional Group return type - Changed 'group?.stringValue() ?? ""' to 'group.stringValue()' - Matches actual SDK behavior where Group is non-optional in success callback
Added JSON response payloads to 49 iOS SDK documentation files: Authentication & Connection: - authentication-overview.mdx - Login/logout payloads - login-listeners.mdx - Connection event payloads - connection-status.mdx - Connection state payloads - web-socket-connection-behaviour.mdx - WebSocket payloads - managing-web-socket-connections-manually.mdx - Manual connection payloads Users: - users-overview.mdx - User object payloads - user-management.mdx - Create/update user payloads - user-presence.mdx - Presence status payloads - retrieve-users.mdx - User list payloads - block-users.mdx - Block/unblock payloads Groups: - create-group.mdx - Group creation payloads - update-group.mdx - Group update payloads - delete-group.mdx - Group deletion payloads - join-group.mdx - Join group payloads - leave-group.mdx - Leave group payloads - retrieve-group-members.mdx - Member list payloads - group-add-members.mdx - Add members payloads - group-kick-member.mdx - Kick member payloads - group-change-member-scope.mdx - Scope change payloads - transfer-group-ownership.mdx - Ownership transfer payloads Messaging: - send-message.mdx - Send message payloads - receive-message.mdx - Receive message payloads - edit-message.mdx - Edit message payloads - delete-message.mdx - Delete message payloads - delete-conversation.mdx - Delete conversation payloads - threaded-messages.mdx - Thread message payloads - additional-message-filtering.mdx - Filter payloads - typing-indicators.mdx - Typing indicator payloads - delivery-read-receipts.mdx - Receipt payloads - reactions.mdx - Reaction payloads - mentions.mdx - Mention payloads - transient-messages.mdx - Transient message payloads - interactive-messages.mdx - Interactive message payloads - flag-message.mdx - Flag message payloads Calling: - calling-setup.mdx - Call setup payloads - default-calling.mdx - Default call payloads - direct-calling.mdx - Direct call payloads - standalone-calling.mdx - Standalone call payloads - recording.mdx - Recording payloads - call-logs.mdx - Call log payloads Push Notifications: - increment-app-icon-badge-count.mdx - Badge count payloads - launch-call-screen-on-tap-of-push-notification.mdx - Call notification payloads - launch-chat-window-on-tap-of-push-notification.mdx - Chat notification payloads - marking-delivered-with-push-notification.mdx - Delivery marking payloads - prepare-your-app-for-background-updates.mdx - Background update payloads - remove-delivered-notifications.mdx - Notification removal payloads AI Features: - ai-agents.mdx - AI agent payloads - ai-moderation.mdx - AI moderation payloads Delegates & Listeners: - all-real-time-delegates-listeners.mdx - All delegate payloads
- Fixed logout method signature in Quick Reference: Changed from CometChatUIKit.logout(onSuccess:onError:) to CometChatUIKit.logout(user:result:) - Fixed Users component method names in property-changes.mdx: Changed set(trailView:) to set(trailingView:) Changed set(subtitleView:) to set(subtitle:) - Fixed Groups component method names in property-changes.mdx: Changed set(trailView:) to set(trailingView:) Changed SetSubTitleView to set(subtitle:) 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.
Fixed logout method signature in Quick Reference: Changed from CometChatUIKit.logout(onSuccess:onError:) to CometChatUIKit.logout(user:result:)
Fixed Users component method names in property-changes.mdx: Changed set(trailView:) to set(trailingView:) Changed set(subtitleView:) to set(subtitle:)
Fixed Groups component method names in property-changes.mdx: Changed set(trailView:) to set(trailingView:) Changed SetSubTitleView to set(subtitle:)
Added DOCUMENTATION_REVIEW_REPORT.md with complete verification details
All changes verified against actual SDK source code and tested with a complete sample application that builds and runs successfully.
Description
Related Issue(s)
Type of Change
Checklist
Additional Information
Screenshots (if applicable)