iOS

This page contains an overview of all relevant changes made to the iOS SDK and the latest version releases.

Version 6.46.0 (2024-11-22)

New Features:

  • Introduced the ability to retrieve the current network's user and social settings.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.45.0 (2024-11-25)

New Features:

  • Introduced the Livestream notification setting for the Community.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.44.0 (2024-10-10)

New Features:

  • Introduced createPrivilegedPost to the AmityPermission enum.

  • Introduced getGlobalPinnedPosts method to query globally featured posts.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.42.1 (2024-09-20)

Fixes

  • Fixed an issue where Community Categories live collection would not notify when no categories were available.

Compatibility

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.42.0 (2024-09-13)

New Features

  • Added functionality to search posts based on semantics in Post Repository.

Compatibility

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.41.0 (2024-08-15)

New Features

  • Introduced the removal of deleted users when querying Followers, Followings, and Blocked users.

Compatibility

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.40.0 (2024-08-02)

New Features

  • Introduced includeDeleted parameter for getMembers and searchMembers methods in AmityChannelMembership class. By default, includeDeleted is set to true.

  • Introduced includeDeleted parameter for getMembers and searchMembers methods in AmityCommunityMembership class. By default, includeDeleted is set to true.

Fixes

  • Fixed a crash caused by MQTT Library.

Compatibility

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.39.0 (2024-07-19)

New Features

  • Introduced the getPosts(postIds: [String]) -> AmityCollection<AmityPost> API in AmityPostRepository to retrieve a list of posts at once.

Fixes

  • Fixed a crash occurring on pin post-live collection.

Compatibility

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 5.33.9 (2024-07-19)

New Features

  • Introduced removal of invalid channels upon SDK initialization.

  • Introduced skipping of persisting conversation channels if the current user is not a member when querying channels.

Compatibility

  • Xcode Version: 15.0

  • Realm Version: 10.42.0

  • Minimum Target: iOS 13.0


Version 6.38.0 (2024-07-12)

New Features

  • Enhanced performance for uploading images, videos, and files.

  • Introduced features for announcement posts and pinned posts - Pinned Post.

  • Added the capability to monitor SDK network activities - Logging.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.37.0 (2024-07-05)

Fixes

  • Fixed an issue where the completion handler wasn't called when the user downloaded the same files from the FileRepository.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.36.0 (2024-06-19)

New Features

  • Introduced Ad analytics. For more information please visit Ads.

Fixes

  • Fixed unread count not updating properly when receiving an event from the users.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.35.0 (2024-06-06)

New Features

  • Introduced AmityAdRepository to the query network ads and settings. For more information please visit Ads.

Deprecations

  • Deprecated the global feature from the AmityRegion enum.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0

Version 6.34.0 (2024-05-24)

New Features

Fixes

  • Fixed an issue where the unread count at the channel level was not updating properly.

  • Fixed a problem where reactions did not display correctly on newly created messages.

  • Fixed an issue with the Privacy Manifest file in the RealmSwift framework.

Depreciations

  • Deprecated unregisterPushNotification(forUserId userId: String?) method. Used unregisterPushNotification() .

Link to gist

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.3

  • Realm Swift Version: 10.49.3

  • Minimum Target: iOS 13.0


Version 6.33.1 (2024-05-15)

Fix

  • Support for filenames with non-English characters is now added.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.1

  • Realm Swift Version: 10.49.1

  • Minimum Target: iOS 13.0


Version 6.33.0 (2024-04-26)

New Features

  • Introduce a displayName option in AmityCommunityMembershipSortOption.

  • Add support for a sortBy option in community member searches within AmityCommunityRepository.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.1

  • Realm Swift Version: 10.49.1

  • Minimum Target: iOS 13.0


Version 6.32.0 (2024-04-12)

New Features

  • Added Privacy Manifest files in AmitySDK, AmityVideoPlayerKit and AmityLiveVideoBroadcastKit.

  • Introduce secureLogout() method in AmityClient, enabling revoking of accessToken upon logout.

  • Introduce a dedicated function for community search, searchCommunities(options:) in AmityCommunityRepository.

Deprecations

  • Deprecated keyword parameter in AmityCommunityQueryOptions.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.49.1

  • Realm Version: 10.49.1

  • Minimum Target: iOS 13.0


Version 6.30.0 (2024-03-22)

New Features

  • Enhanced user login session.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.28.0 (2024-02-24)

New Features

  • Introduced functionality to validate whitelisted URLs - Validate URL.

  • Introduced capability to screen for banned text - Validate Text.

  • Introduced custom post creation in AmityPostRepository - Custom Post.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.27.0 (2024-02-09)

New Features

  • Introduced an ability to subscribe to story realtime-events STORY Topic.

  • Introduced an ability to send a message in a broadcast channel via SDK.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.26.0 (2024-01-25)

New Features

Implement consistent message unread count for channels & subchannels - for further information please visit - SDK v6.26.0 Unread Count Migration Guide.

  • New enableUnreadCount() method in AmityClient which enables unread count feature for messages.

  • New syncUnreadCount() method in AmityClient Unread Count.

  • New subChannelsUnreadCount property in AmityChannel

  • New startMessageReceiptSync() & stopMessageReceiptSync() methods in AmitySubChannelRepository- Observe reading count.

  • New markRead() method in AmityMessage - Mark Message as Read.

  • New isMentioned property in AmityChannel & AmitySubChannel

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.25.1 (2024-01-19)

Fixes

  • Fixed the issue where the message preview was removed when someone left the channel.

  • Fixed issue where message preview does not contain correct user object.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.24.0 🎄🎅 (2023-12-22)

New Features:

  • Introduce new api getChannels(channelIds: [String]) to query channel by ids. For further information please visit Get Channels.

Fixes:

  • Fixed issue where failed messages did not appear at the bottom of the live collection when a new message is sent.

  • Fixed issue where user would not get notified in case of error while updating current user information

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.23.0 (2023-12-01)

New Features:

  • Added support for waiting for connectivity before sending message.

  • Added support for queuing of messages of similar types & retrying of message in case of network errors.

  • For further information please visit #message-resynchronization.

Deprecations:

AmityCommunityMembership

  • Deprecated getMembers(membershipOptions: AmityCommunityMembershipFilterOption, roles: [String], sortBy: AmityCommunityMembershipSortOption) please use getMembers(filter: AmityCommunityMembership.QueryFilter, roles: [String], sortBy: AmityCommunityMembershipSortOption) instead.

  • Deprecated searchMembers(keyword: String, membership membershipOptions: AmityCommunityMembershipFilterOption, roles: [String], sortBy: AmityCommunityMembershipSortOption) -> AmityCollection<AmityCommunityMember> please use searchMembers(keyword: String, filter: [AmityCommunityMembership.SearchFilter], roles: [String]) instead.

AmityMessageRepository

  • Deprecate deleteFailedMessage(_ messageId: String). Use softDeleteMessage(withId:) instead.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.22.0 (2023-11-17)

New Features:

  • Added support for metadata when creating and updating image, file, audio and video message.

  • Added functionality to create private community channel.

Fixes:

  • Fixed crash issue when playing recorded livestream video.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.21.0 (2023-11-03)

New Features:

  • Fixed the issue where there were occasional crashes when unable to get the object.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.20.0 (2023-10-20)

New Features:

  • Introduced AmityMessageAttachment in message create options structs.

Fixes:

  • Fixed the issue where the member list did not update after removing user in a group channel.

Deprecations:

  • Deprecated init(subChannelId: String, imageURL: URL, caption: String? = nil, fullImage: Bool, tags: [String]? = nil, parentId: String? = nil) in AmityImageMessageCreateOptions, use init(subChannelId: String, attachment: AmityMessageAttachment, caption: String? = nil, fullImage: Bool = true, tags: [String]? = nil, parentId: String? = nil) instead

  • Deprecated init(subChannelId: String, fileURL: URL, fileName: String? = nil, caption: String? = nil, tags: [String]? = nil, parentId: String? = nil) in AmityFileMessageCreateOptions, use init(subChannelId: String, attachment: AmityMessageAttachment, fileName: String? = nil, caption: String? = nil, tags: [String]? = nil, parentId: String? = nil) instead.

  • Deprecated init(subChannelId: String, audioFileURL: URL, fileName: String? = nil, tags: [String]? = nil, parentId: String? = nil) in AmityAudioMessageCreateOptions, use init(subChannelId: String, attachment: AmityMessageAttachment, fileName: String? = nil, tags: [String]? = nil, parentId: String? = nil) instead.

  • Deprecated init(subChannelId: String, videoFileURL: URL, fileName: String? = nil, tags: [String]? = nil, parentId: String? = nil) in AmityVideoMessageCreateOptions, use init(subChannelId: String, attachment: AmityMessageAttachment, fileName: String? = nil, tags: [String]? = nil, parentId: String? = nil) instead.

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.19.1 (2023-10-16)

Dependency Update:

  • Updated Realm Swift v10.42.3

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.19.0 (2023-10-06)

New Features:

  • Add new feature to preview latest message sent in channel or subchannel. For more information, please visit Message Preview

  • Add a new feature for SDK to collect and view data of post interaction. For more information, please visit Post Impression.

  • Introduced AmityRecordedStreamPlayer for enhanced livestream playback. This subclass of AVPlayer seamlessly integrates with AVPlayerViewController for an improved video-watching experience. For more information, please visit Play recorded videos.

Fixes:

  • Fixed issue where newly created message is not in correct position when observing through live collection

  • Fix community user got overwritten when it's a same user id on different community

Breaking Changes:

  • Obsoleted watcherUrl and recordingData properties in AmityStream.

  • Use AmityVideoPlayer to watch livestreams since watcherUrl is obsoleted. For more information, please visit Play a live stream

  • Use AmityRecordedStreamPlayer to watch recorded livestreams. For more information, please visit Play recorded videos

Compatibility:

  • Xcode Version: 15.0

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.18.0 (2023-09-22)

Features

  • Introduced an additional parameter in message query, called aroundMessageId, to support navigating to a specific message. For more information, please visit Navigating(Jump) to a specific message.

  • Fixed an issue where isDeleted property of message is not updated when message gets deleted.

  • Fixed a crash issue caused by QueryStreamReactor.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.42.3

  • Realm Swift Version: 10.42.3

  • Minimum Target: iOS 13.0

Version 6.17.0 (2023-09-08)

Features

  • Introduced target: AmityCommentTarget property in AmityComment for retrieving targetId and targetType related to the comment. If targetType is community type, the SDK will also provide creatorMember which is AmityCommunityMember.

  • Supported community users in comments for moderator role checking.

  • Added SwiftUI support for AmityCollection and AmityObject., for more information please visit SwiftUI Support page.

  • Fixed the issue where MQTT events were not received in the SDK.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.41.1

  • Realm Swift Version: 10.41.1

  • Minimum Target: iOS 13.0

Version 6.16.1 (2023-09-04)

Fixes

  • Fixed an issue where the message list jumps when adding reactions.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.42.0

  • Realm Swift Version: 10.42.0

  • Minimum Target: iOS 13.0

Version 6.16.0 (2023-08-25)

Features

  • Added a new API to retrieve a comment using its ID.

Fixes

  • Fixed an issue where the SDK would not update pendingCount correctly after the user accepted or declined a follow action.

  • Fixed an issue with sub-channel sorting not updating after receiving a message.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.42.0

  • Realm Swift Version: 10.42.0

  • Minimum Target: iOS 13.0

Version 6.15.2 (2023-08-23)

Fixes

  • Fixed an issue where the SDK incorrectly returned the follow relationship status in the followInfo call, especially when querying for multiple follow relationships.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.42.0

  • Realm Swift Version: 10.42.0

  • Minimum Target: iOS 13.0

Version 6.15.1 (2023-08-16)

Fixes

  • Fixed the issue where the order of image messages was incorrect in certain cases.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.42.0

  • Realm Swift Version: 10.42.0

  • Minimum Target: iOS 13.0

Version 6.15.0 (2023-08-10)

Features

  • Limited PostRepository.getPosts() to exclude all deleted posts (both soft and hard deletes) not owned by the logged-in user, aligning with this#behavioral-change-announcement.

Fixes

  • Fixed the issue where the myReactions property is not updated correctly when a message is received.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.42.0

  • Realm Swift Version: 10.42.0

  • Minimum Target: iOS 13.0

Version 6.14.0 (2023-08-04)

Features

  • Introduced the new Presence State feature in our SDK, allowing real-time synchronization of user statuses. Experience enhanced connectivity with online/offline indicators and seamless management of user presence within channels and users.

  • Supports unread mention status in user, channel, and subchannel levels. For further information, please refer to Unread Count the page.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.41.1

  • Realm Swift Version: 10.41.1

  • Minimum Target: iOS 13.0

Version 5.33.8 (2023-08-04)

Fixes

  • Updated Realm version to 10.42.0 and fixed random Realm crashes.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.42.0

  • Realm Swift Version: 10.42.0

  • Minimum Target: iOS 13.0

Version 6.13.1 (2023-08-02)

Fixes

  • Fixed the issue where the number of following/followers does not update.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.41.1

  • Realm Swift Version: 10.41.1

  • Minimum Target: iOS 13.0

Version 6.7.0 (2023-07-27)

Fixes

  • Resolved an issue that occasionally caused duplicate message displays within the message list.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.41.1

  • Realm Swift Version: 10.41.1

  • Minimum Target: iOS 13.0

Fixes

  • Fixed the issue of unread counts not reflecting correctly after a topic is hard deleted.

  • Fixed the issue of unread counts not being synchronized correctly after a user is removed or banned.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Version 6.12.0 (2023-07-14)

New Features

  • Introduced AmityFileRepository where users can now delete uploaded files by using deleteFile API. For further information, please visit Delete Files

  • Added getFile API to retrieve the AmityRawFile. AmityRawFile provides transform functions to map it into the correct file data type. For further information, please visit Retrieve Files

Fixes

  • Fixed the issue where the SDK does not show all tagged message lists when querying with a tag.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Version 6.11.1 (2023-07-10)

Fixes

  • Resolved the issue of incorrectness in the user's search result.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Fixes

  • Fixed the issue where the unread count does not sync when two devices, both using the same account, are opened simultaneously.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Fixes

  • This update fixes returning missing messages when specified includingTags as one of the query options.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Version 6.11.0 (2023-06-29)

Fixes

  • Fixed an issue where searching for users with keywords would return incorrect results.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Version 5.33.7 (2023-06-22)

Fixes

  • This update fixes returning wrong result when searching user with keyword.

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 6.6.0-beta3 (2023-06-21)

New Features

  • Introduce a new feature which now supports unread count on multiple devices. When the user logs in to two devices with the same account and uses the chat feature simultaneously, the user should see the correct update of the unread count.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Version 6.10.0 (2023-06-16)

Features

  • Support Library Evolution in AmitySDK and UIKit, ensuring forward compatibility with future Xcode versions 🎉.

  • Resolved an issue with the sort order for user lists and community categories.

  • Fixed a crash that occurred when searching for channel members with roles.

Compatibility

  • Xcode Version: 14.3.1

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Version 6.9.0 (2023-06-01)

Deprecations

Compatibility

  • Xcode Version: 14.3

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Version 5.33.6 (2023-05-25)

Fixes

  • This update fixes crash issue on linked libraries.

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 5.33.5 (2023-05-19)

Fixes

  • Fix issue when clicking "unlike" on a post with multiple likes, the number of likes should decrease by only 1 instead of resetting to 0.

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 6.8.0 (2023-05-18)

New features

  • Introduce new creator object which returns AmityUser in AmityReaction model.

Deprecations

Compatibility:

  • Xcode Version: 14.3

  • Realm Version: 10.39.1

  • Realm Swift Version: 10.39.1

  • Minimum Target: iOS 13.0

Version 6.7.0 (2023-05-9)

New features

  • Add async APIs support on more functions, please check the newly supported functions in the deprecation note below.

Deprecations

Compatibility:

- Xcode Version: 14.1

- Realm Version: 10.32.2

- Realm Swift Version: 10.32.2

- Minimum Target: iOS 13.0

New features

  • Introduce message delivered count.

  • Introduce mark all messages in a channel as read

  • For further information please visit Unread Count.

Compatibility:

- Xcode Version: 14.1

- Realm Version: 10.32.2

- Realm Swift Version: 10.32.2

- Minimum Target: iOS 13.0

Version 6.6.0 (2023-04-20)

New features

  • Introduce blocking/unblocking user feature.

  • Introduce unread count in channels and subchannels.

  • Add async APIs in AmityFileRepository, AmityReactionRepository, AmityUserNotificationsManager and AmityChannelParticipation.

Deprecations:

Deprecated completion handler based APIs in these classes. Use async APIs instead.

AmityFileRepository

  • uploadImage, uploadFile, uploadVideo, downloadFile

AmityReactionRepository

  • addReaction, removeReaction

AmityUserNotificatonsManager

  • enable, disable

AmityChannelParticipation

  • addMembers, removeMembers

Compatibility:

- Xcode Version: 14.1

- Realm Version: 10.32.2

- Realm Swift Version: 10.32.2

- Minimum Target: iOS 13.0

Version 6.5.0 (2023-03-28)

Fixes:

  • Fix channel user role does not persist properly.