About UsDeveloper PortalArchives

iOS

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

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 Send a Message.

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 messa

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 thisiOS.

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 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 a 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

Version 6.6.0-beta06 (2023-07-17)

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

Version 6.6.0-beta05 (2023-07-04)

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

Version 6.6.0-beta04 (2023-06-29)

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

Version 6.6.0-beta02 (2023-05-5)

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.

  • Fix sometimes crash on initialize AmityClient

  • Fix issue where message `isEdited` property would be true even when message was not edited.

  • Fix crash while watching live stream videos.

Deprecations

Compatibility:

- Xcode Version: 14.1

- Realm Version: 10.32.2

- Realm Swift Version: 10.32.2

- Minimum Target: iOS 13.0

Version 5.33.3 (2023-05-22)

Fixes

  • Fixed an issue that was causing random crashes during the initialization of the AmityClient.

  • Fixed an issue that was causing random crashes while watching live stream videos.

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 6.2.2 (2023-03-16)

Improvement

  • The error messages have been improved to provide more clarity in certain cases. In particular, the error 800000 unknown has been dealt with in more detail.

Version 6.2.1 (2023-03-14)

Improvement

  • Improved the error messages for more clarity in certain cases.

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

Version 6.4.0 (2023-03-13)

New Features

Fixes:

  • Fixed issue where the SDK crashes on initializing AmityChannelRepository.

Compatibility:

  • Xcode Version: 14.1

  • Realm Version: 10.32.2

  • Realm Swift Version: 10.32.2

  • Minimum Target: iOS 13.0

Version 5.33.2 (2023-03-07)

Fixes

  • Fixed issue where the SDK crashes for some users with the error message "Cannot register notification blocks from within write transactions".

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 6.3.0 (2023-02-24)

New Features

  • AmityUser Live Collection now supports the automatic addition of new objects via real-time events. Affected APIs:

AmityUserRepository
func searchUser(_ displayName: String, sortBy: AmityUserSortOption) -> AmityCollection<AmityUser>

func getUsers(_ sortBy: AmityUserSortOption) -> AmityCollection<AmityUser>

Fixes

  • Fixed issue where the SDK crashes for some users with the error message "Cannot register notification blocks from within write transactions".

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 5.33.1 (2023-02-17)

Fixes

  • Fixed issue where the SDK crashes for some users with the error message "Cannot register notification blocks from within write transactions".

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 6.2.0 (2023-02-09)

Fixes

  • Fixed issue where local cache was cleared on query channels with 'firstPage'.

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.32.2

  • Realm Swift Version: 10.32.2

  • Minimum Target: iOS 13.0

Version 6.1.0 (2023-02-03)

New Features

  • AmityCommunityMember Live Collection now supports the automatic addition of new objects via real-time events. Affected APIs:

AmityCommunityRepository
func searchMembers(...) -> AmityCollection<AmityCommunityMember>

  • Added new API for searching community members with keywords.

AmityCommunityRepository
func searchMembers(communityId: String, keyword: String, membership membershipOptions: AmityCommunityMembershipFilterOption, roles: [String], sortBy: AmityCommunityMembershipSortOption) -> AmityCollection<AmityCommunityMember>

  • AmityCommunity Live Collection now supports automatic addition of new items via real-time events. Affected APIs:

AmityCommunityRepository
func getCommunities(...) -> AmityCollection<AmityCommunity>

  • Added async/await API for deleteMessage, createCustomMessage, createTextMessage, createImageMessage, createAudioMessage, createFileMessage and createVideoMessage in AmityMesageRepository.

  • Introduced the ability to delete on a specific poll post.

AmityPollRepository
func deletePoll(...)

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 6.0.0 (2023-01-13)

New Features

  • Introduced Sub Channel functionality. Now users can create sub channels inside a channel.

Deprecations

  • All deprecated interfaces from AmitySDK v5.x.x has been removed in AmitySDK v6.0.0.

Breaking Changes

  • AmitySDK v6.0.0 has been written in PureSwift. This version has breaking changes in api interfaces. Please refer to the migration guide for more details.

  • Events related to channels of type Community & Conversation are automatically subscribed. To receive events for other type of channels, user needs to subscribe to it explicitly.

  • For subscribing to channel topics, create an instance of the AmityChannelTopic class and use the AmityTopicSubscription class to subscribe to it.

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.32.2

  • Realm Swift Version: 10.32.2

  • Minimum Target: iOS 13.0

Version 5.33.0 (2022-12-16)

New Features

AmityClient {
    public func login(userId: String, displayName: String?, authToken: String?, sessionHandler: SessionHandler) async throws
}

  • Added sesionState API to AmityClient

  • Added issuedAt, expiresAt API to AmityUserToken

Fixes

  • Fixed issue where the user could not send a reply to image messages

  • Fixed issue where the user could not see the existing message when editing it

Deprecations

  • Deprecated connectionState API

  • Deprecated old login API

AmityClient {
    @available(*, deprecated) 
    @objc public func login(userId: String, displayName: String?, authToken: String?, completion: AmityRequestCompletion?)
}

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 5.32.0 (2022-12-02)

Fixes

  • SDK Upgrade

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 5.31.0 (2022-11-18)

New Features

  • Upgraded the post settings feature. When a moderator role is demoted to a user role, post creation must be approved by a moderator.

  • Introduced the ability to get video thumbnail image data from video messages using the AmityMessage.getVideoThumbnailImageInfo() function.

Fixes

  • Fixed issue where the application crashes when a globally banned user sends a message in a channel.

Compatibility

  • Xcode Version: 14.1

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 5.30.0 (2022-11-04)

New Features

  • Introduced the ability for User roles to create community with “Admin can post only” settings.

Fixes

  • Fixed issue where the global feed is not updated after creating a post in the community feed or user feed.

Compatibility

  • Xcode Version: 14.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 5.29.0 (2022-10-21)

New Features

  • Introduced the ability to query poll type.

  • Introduced a new moderatorCount property in AmityChannel to show the total number of moderator in the channel.

  • Introduced the ability to query message by type.

Fixes

  • Fixed issue where channels with a certain ID were not retrieved correctly.

Compatibility

  • Xcode Version: 14.0.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 13.0

Version 5.28.1 (2022-10-18)

Fixes

  • Fixed issue where the application crashes with errorCannot register notification blocks from within write transactions when fetching Live Object or Live Collection within observe block.

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 12.0

Version 5.28.0 (2022-10-07)

New Features

  • Introduced the ability to create video messgaes in Live, Broadcast, Community and Chat channels.

  • When creating a poll post, the setTimeToClosePoll value is set to 30 days by default if the user does not set any value.

Fixes

  • Fixed issue where the application crashes when the user adds a reaction to a message.

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 12.0

Version 5.27.0 (2022-09-23)

Fixes

  • Fixed issue where SDK tries to query the current user after logging in.

  • Fixed issue where the isJoined property for AmityCommunity is not updated properly when a user leaves the community.

  • Fixed issue where the URL of the downloaded file is the same for multiple downloads.

  • Non-members with the User role can no longer be able to get information about the conversation channel.

  • Non-members with the User role can no longer query messages within the conversation channel.

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 12.0

Version 5.26.1 (2022-09-15)

Fixes

  • Fixed issue where reaction count was incorrect

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 12.0

Version 5.26.0 (2022-09-09)

New Features

  • Community query is now case-insensitive! You no longer have to match the case sensitivity of the community’s display name when querying for a community.

  • System now displays an error message while uploading HDR video format

Fixes

  • Fixed issue where reaction count becomes deficit

  • Fixed muting channel members issue

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 12.0

Version 5.25.0 (2022-08-26)

New Features

  • Enhanced Video on Demand (VOD) configurations. Videos you upload with our SDK can now be transcoded to 4 different resolutions (from 360p to 1080p) with a maximum file size of 1 GB and a duration of up to 2 hours.

  • New method uploadVideo(with:forFeedType:progress:completion:) is added in AmityFileRepository

Fixes

  • Fixed issue where automatic invalidation of live collections happen once the session is logged out

  • Fixed issue where all SDK async functions are forced to be invoked on the main thread

  • Fixed issue where user cannot view post which has multiple videos

Deprecations

  • Deprecated uploadVideo(with:progress:completion:) method in AmityFileRepository

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 12.0

Version 5.24.0 (2022-08-11)

New Features

  • Enhanced LiveCollections for message reactions. Newly created reactions are now automatically added into the collection. Affected APIs:

AmityReactionRepository
func getReactions(...) -> AmityCollection<AmityReaction>

  • Enhanced LiveCollections for followers/following users. Newly created followed/unfollowed are now automatically added into the collection. Affected APIs:

AmityUserFollowManager
func getMyFollowerList(...) -> AmityCollection<AmityFollowRelationship>
func getMyFollowingList(...) -> AmityCollection<AmityFollowRelationship>
func getUserFollowerList(...) -> AmityCollection<AmityFollowRelationship>
func getUserFollowingList(...) -> AmityCollection<AmityFollowRelationship>

Fixes

  • Fixed realtime events .myFollower and .myFollowing in AmityFollowTopic which subscribes to the wrong path

  • Fixed issue where user cannot submit vote when a poll is closed

  • Fixed issue where user cannot edit caption when a poll is closed

Dependency Changes

  • Updated Realm version to 10.28.3

Deprecations

  • DeprecatedAmityMessageReactor class. Please use AmityReactionRepository instead.

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.28.3

  • Minimum Target: iOS 12.0

Version 5.23.0 (2022-07-29)

New Features

  • Enhanced LiveCollections for users and community post. Newly added comments are now automatically added into the collection. Affected APIs:

AmityCommentRepository
func getCommentsWithReferenceId(...) -> AmityCollection<AmityComment>

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.26.0

  • Minimum Target: iOS 12.0

Version 5.22.0 (2022-07-15)

New Features

  • Enhanced LiveCollections for user and community posts. Newly created posts are now automatically added into the collection. Affected APIs: 

AmityFeedRepository
func getUserFeed(...) -> AmityCollection<AmityPost>
func getCommunityFeed(...) -> AmityCollection<AmityPost>

  • Introduced real-time event for channel deletion

Fixes

  • Fixed issue with app crashes when searching members with AmityCommunityRepository

  • Fixed some SDK errors to no longer show empty error messages

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.26.0

  • Minimum Target: iOS 12.0

Version 5.21.0 (2022-07-04)

New Features:

  • Introduced ability to manage community post settings via SDK (i.e. 'Only Admins Can Post' or 'Approve Member Posts')

Fixes:

  • Fixed issue where users who weren't logged in were receiving push notifications.

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.26.0

  • Minimum Target: iOS 12.0

Version 5.20.0 (2022-06-17)

Dependency Changes

  • Updated Realm to 10.26.0

Compatibility

  • Xcode Version: 13.4.0

  • Realm Version: 10.26.0

  • Minimum Target: iOS 12.0

Version 5.19.0 (2022-06-02)

New Features

  • Added channel async/await APIs including create / join / update / leave.

Deprecations

  • Deprecate channel create / join update / leave that returns live object. Please use equivalent channel async/await APIs instead.

Version 5.18.0 (2022-05-20)

New Features

  • Real time update of user deletion

Compatibility

  • Xcode Version: 13.2

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.17.0 (2022-05-09)

New Features

  • Update image and file post by adding/removing them from the existing post

Compatibility

  • Xcode Version: 13.2

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.16.0 (2022-04-22)

New Features

  • Add isDeleted property to AmityUser.

Fixes

  • Fix issue where message unread count indicates incorrect value.

Compatibility

  • Xcode Version: 13.2

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.15.0 (2022-03-31)

New Features

  • Update video post by adding/removing the video from the existing post

  • Realtime events for comments and posts in the user feed

Fixes

  • Fix a channel member list sorting issue

  • Fix issue where querying channels with empty result doesn’t trigger completion block

  • Fix issue where targetUser and sourceUser from AmityFollowRelationship are always null when querying following/follower list

Compatibility

  • Xcode Version: 13.2

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.14.0 (2022-03-17)

New Features

Fix

  • Fix channel member list sorting issue

Breaking Changes

  • Deprecate getMyFollowInfo:completion and getUserFollowInfo:completion API

Compatibility

  • Xcode Version: 13.1

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.13.1 (2022-03-11)

Fixes

  • Fix issue where unreadCount in AmityChannel class isn’t updated and miscalculated

  • Fix issue where new messages sent by another user don't appear while observing AmityMessageListScreenViewModel.getMessages(:)

Compatibility

  • Xcode Version: 13.1

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.13.0 (2022-03-03)

Fixes

  • Fix crash related to mqtt realtime events on SDK

  • Fix issue where community category did not update when realtime event is received

  • Fix unregister notification issue

  • Fix mention highlight issue for reply

  • Framework installation via Cocoapods doesn’t support running on M1 natively

Compatibility

  • Xcode Version: 13.1

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.12.0 (2022-02-17)

New Features

  • Create a livestream post with mentions

  • Add push notification log menu in the sample app

Fixes

  • Fix mention selection issue in editing mode for a message

  • Fix comment reply mention highlight issue after editing

  • Fix crash issue when fetching channel with certain filter

Compatibility Xcode

  • Version: 13.1

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.11.0 (2022-02-04)

New Features

  • Create a poll post with mentions

Fixes

  • Fix mention highlight issue after editing a message

  • Fix channel filter issue

  • Fix compose bar appearance issue after mentioning in a comment

  • Fix mentioned user remove issue on edit message page

Compatibility

  • Xcode Version: 13.1

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.10.0 (2022-01-25)

New Features

  • Hard delete post and comment

  • Old mentions in a message will not be removed after editing the message

  • Custom post ranking global feed to support a score-sorting mechanism

  • User level notification error

  • Live collection allObjects API

Fix

  • Compose bar text wrapping issue when creating a message, post, and comment

Breaking Changes

  • Add hardDelete parameter to Post and Comment deletion API

AmityPostRepository.deletePost(withPostId:, parentId:, hardDelete:, completion:)

AmityCommentRepository.deleteComment(withId:, hardDelete:, completion:)

Compatibility

  • Xcode Version: 13.1

  • Realm Version: 10.21.1

  • Minimum Target: iOS 12.0

Version 5.9.0 (2021-12-24)

New Features

  • Add properties createdAt, updatedAt, rateLimit to AmityChannel.

  • Add AmityClient.disconnect() API

  • Add support for real time events for social module

  • Create/Update comment/reply with mention

Fix

  • Update many functions documentation in SDK

Breaking Changes

  • Rename AmityClient functions

    Before SDK 5.9.0
    SDK 5.9.0

    registerDevice(...)

    login(...)

    unregisterDevice()

    logout()

  • Rename AmityMessageMentionMetadata to AmityMentionMapper

  • Change AmityClient initializer to throwable initializer

    class AmityClient {
    public init(...) throws
}

  • Change all message creation API in AmityMessageRepository to callback-style Before SDK 5.9.0

    let messageLiveObject = messageRepository.createTextMessage(...)
token = messageLiveObject.observe(...) {
    // 1. Handle message creation response.
    // 2. Observe message data changes.
}

    SDK 5.9.0

    let messageId = messageRepository.createTextMessage(...) { message, error in
    // 1. Handle message creation response.
}
token = messageRepository.getMessage(messageId).observe {
    // 2. Observe message data changes.
}

  • Simplify channel creation API Before SDK 5.9.0: The API requires chaining .channelType(with:) after calling .createChannel()

    token = channelRepository.createChannel().community(with: builder).observe { channel, error in
    /// ...
}

    SDK 5.9.0: The builder can be passed to createChannel(with:) directly

    token = channelRepository.createChannel(with: builder).observe { channel, error in
    /// ...
}

  • Simplify channel update API Before SDK 5.9.0: Developers need to create an updater and call updater.update()

    let updater = channelRepository.updateChannel(channelId)
token = updater.update().observe { channel, error in
    // ...
}

    SDK 5.9.0: Developers can call updateChannel(with:) directly

    token = channelRepository.updateChannel(with: builder).observe { channel, error in
    // ...
}

  • Simplify channels query API Before SDK 5.9.0: Developers need to create a query builder for a specific channel type. To pass the query builder, developers need to pick the correct channel type function after .getChannel() call

    let builder = AmityCommunityChannelQueryBuilder(...)

let collection = repository.getChannels().communityType(with: builder).query()
token = collection.observe { collection, error in
    // ...
}

    SDK 5.9.0: Developers can create a generic AmityChannelQuery and pass it to .getChannels(with:) directly. To filter channel types, developers can set query.types which the value can be found in AmityChannelQueryType.

    let query = AmityChannelQuery()
query.types = [AmityChannelQueryType.conversation]
query.filter = .all
query.includingTags = ["dog"]
query.excludingTags = ["cat"]
query.includeDeleted = false

token = channelRepository.getChannels(with: query).observe { collection, error in
    // ...
}

  • Deprecate the following methods:

    • AmityClient(apiKey:_, httpUrl:_, socketUrl:_)

    • AmityClient(apiKey:_, url:_) Use the following methods instead:

    • Use AmityClient(apiKey:_, region:_)

    • AmityClient(apiKey:_, endpoint:_) methods instead.

  • AmityRegionalEndpoint is now deprecated. Use AmityRegion instead.

    // New Way:
let client = AmityClient(apiKey: "api-key", region: .global)

  • clientErrorDelegate in AmityClient is now deprecated. A new delegate property is introduced in AmityClient. Now you can observe connection status change through delegate itself.

    let client = AmityClient(...)
client.delegate = self
…

extension MyClass: AmityClientDelegate { 
        
        func didChangeConnectionStatus(status: AmityConnectionStatus) { 
                // Observe connection status change here
        }
        
        func didReceiveError(error: Error) { 
                // Handle Error
        }
}

Compatibility

  • Xcode Version: 13.1

  • Realm Version: 10.20.0

  • Minimum Target: iOS 12.0

Version 5.8.0 (2021-12-09)

New Features

  • Create/Update text, image, video and file post with mention

  • New addRoles and removeRoles functions to add and remove roles respectively in AmityCommunityModeration

  • Add isGlobalBan property in AmityUser to show whether user is globally banned or not

  • New AmityCommunityMembershipFilterOption filter option for community membership

  • New buildForPostUpdate method in AmityPostBuilder protocol to update post

  • New buildForPostUpdate method in AmityImagePostBuilder and AmityFilePostBuilder

Breaking Changes

  • addRole and removeRole methods are deprecated in AmityCommunityModeration

  • filter parameter is removed and a new membershipOptions parameter is provided for getMembers function to filter community members in AmityCommunityParticipation

  • setFileData is renamed to setFiles method in AmityFilePostBuilder

  • setImageData is renamed to setImages method in AmityImagePostBuilder

Compatibility

  • Xcode Version: 13.1

  • Realm Version: 10.20.0

  • Minimum Target: iOS 12.0

Version 5.7.2 (2021-11-15)

Fix

  • App crashes when calling getMyFollowerList() or getMyFollowingList() of AmityUserFollowManager

Compatibility

  • Xcode Version: 12.5

  • Realm Version: 10.12.0

  • Minimum Target: iOS 12.0

Version 5.7.1 (2021-11-02)

Fixes

  • Fix community search issue

  • Fix realm crash by checking if realm session object is still valid before accessing it

Compatibility

  • Xcode Version: 12.5

  • Realm Version: 10.12.0

  • Minimum Target: iOS 12.0

Version 5.7.0 (2021-10-14)

New Feature

  • Remove mentionedUsers array from AmityMessage model and provide mentionees (AmityMentionees) array instead

Fixes

  • Do not mention banned users

  • Do not mention user who left the channel

Breaking Changes

Api:

  • AmityMessageFlagger class requires id of the message in init method

    let flagger = AmityMessageFlagger(client: <client>, messageId: <message-id>)

  • AmityUserFlagger class requires user id in init method

    let flagger = AmityUserFlagger(client: <client>, userId: <user-id>)

  • AmityCommentEditor class requires id of the comment in init method

    let editor = AmityCommentEditor(client: <client>, commentId: <comment-id>)

  • AmityMessageReactor class requires id of the message in init method

    let editor = AmityMessageReactor(client: <client>, messageId: <message-id>)

Compatibility

  • Xcode Version: 12.5

  • Realm Version: 10.12.0

  • Minimum Target: iOS 12.0

Version 5.6.1 (2021-09-16)

Fix

  • Realm exception in release 5.6.0

Compatibility

  • Xcode Version: 12.5

  • Realm Version: 10.12.0

  • Minimum Target: iOS 12.0

Version 5.6.0 (2021-09-14)

New features

Mention

  • Support for mention in TEXTmessages

  • Search members by display name

  • Provide unread mention information

  • Provide mention channel configuration

Compatibility

  • Xcode Version: 12.5

  • Realm Version: 10.12.0

  • Minimum Target: iOS 12.0

Version 5.5.0 (2021-08-17)

Fix

  • Upgrade realm to version 10.12.0

Version 5.4.1 (2021-08-13)

Fix

  • Updated channel cache data when ban event is received, while joining channel, and querying messages

Version 5.4.0 (2021-08-3)

Fixes

  • Fixed issue where category values are incorrect for community

  • Fixed issue where comment count does not reflect the correct value after removing comments

Breaking Changes

  • Introduce AmityPostRepository

    • Added getPosts(:_) method for querying post by filter options

  • Deprecated post related functions in AmityFeedRepository. All equivalent functions are moved to AmityPostRepository.

Version 5.3.1 (2021-07-21)

Fixes

  • Feed type querying improvements

  • Fix issue where create post does not return proper data in the completion

Breaking Changes

  • Revise a completion block of createPost: and updatePostWithPostId: methods in AmityFeedRepository from AmityRequestCompletion to AmityPostRequestCompletion

    • AmityPostRequestCompletion represents to (AmityPost?, Error?) -> Void

Version 5.3.0 (2021-07-8)

New Features

Communities

  • Add a function for getting post count by feed type to the AmityCommunity model.

  • Add a function for getting isPostReviewEnabled function to the AmityCommunity model.

  • Add new permission AmityPermission.reviewCommunityPost type

  • Add api for setting isPostReviewEnabled value on create and update community builder.

Follow

  • Add a property followManager to AmityUserRepository to provide follow feature functionalities

  • Add a method to create a Follow request.

  • Add a method to withdraw a Follow request.

  • Add a method to accept a Follow request.

  • Add a method to decline a Follow request.

  • Add a method to get a Follow status.

  • Add a method to get a Follower user list.

  • Add a method to get a Following user list.

  • Add a method to get a Follow request list.

Posts

  • Add AmityFeedType enum

  • Add a function for getting feed type to the AmityPost model.

  • Add api for community feed query by feed type.

  • Add api for post approval.

Breaking Changes

  • Introduce feedType parameter to getCommunityFeed(:_) function in AmityCommunityRepository . Set a parameter .published to support a usual behavior.

  • A live object ofAmityUser where provides by AmityCommunityMember and AmityChannelMember are changed to normal object.

Others

  • Introduce a completion parameter to registerDeviceWithUserId(:_) in AmityClient

  • Fix socket connection state that causes feed cannot be loaded

  • Fix issue where token does not update correctly

  • Fix issue where collection is not triggered when there is empty result

  • Fix edited date does changed after the comment get updated

Version 5.0.2

Fixes

  • Fix no response issue when uploading multiple images

  • Fix crash when fetching user

Version 5.0.1

Fixes

  • Fix issue where custom messages are not parsed correctly

  • Fix crash when setting up custom avatar for in AmityClient class.

Version 5.0.0

Fixes

  • All public methods and classes which contained Eko prefix renamed to Amity: EkoClient renamed to AmityClient , EkoChat renamed to AmitySDK

  • Some classes and methods are modified or removed:

    Remove classes: EkoMessageReactor, EkoMediaRepository.

    Rename method: messages to getMessages in AmityMessageRepository class. Add class: AmityUserUpdateBuilder- to build updates for user Add method: setAvatar(avatar: AmityImageData?) - to set user avatar The full description can be found here

Last updated

Was this helpful?