JavaScript
This page contains an overview of all relevant changes made to the JavaScript SDK and the latest version releases
- Fixed the issue where
AmityUsercan't be flagged in certain situations.
- Fixed the issue where the watch minutes API in video live stream got denied by the backend.
- Introduced
LiveStreamPlayer.getPlayer(), a new API that provides a player for live stream video playback, along with watch time tracking capability.
- Fixed the following user collection pagination issue.
- Add session v3 and
sessionHandlerinto the option for createClient.
- Fixed issue where user access token cannot be renewed after the token is expired.
- ​Fixed issue where error message is not displayed when logging in with deleted user_id.
- SDK Upgrade
- Fixed issue where the Community pending screen is not getting updated when the post is declined.
- Fixed issue where user cannot update comment.
- Upgraded the post review feature. When a moderator role is demoted to a user role, post creation must be approved by a moderator.
- Fixed issue where a user who has not joined a public community can see posts in the global feed.
- Fixed issue where tags were not returned in the response when a community was created with tags.
- Fixed issue where version 5.24.0 JS SDK does not work on Nextjs.
- Fixed issue where a community with metadata could not be created.
- When creating a poll post, the
closedInvalue is set to 30 days by default if the user does not set any value. - Add
​​moderatorMemberCountto the channel model.
- Fixed issue where users occasionally cannot send messages in the channel.
- 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.
- 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
- 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
createVideo(file:File, feedType:ContentFeedType, onProgress:OnProgressCallback)is added inAmityFileRepositoryto specify the content type of the video.
- Fixed issue where user could not create image/file message
- Fixed issue where user could not query a channel
- Fixed issue where user could not view the text on content column in video/image post
- Deprecated
createVideo(file:File, onProgress:OnProgressCallback). Please usecreateVideo(file:File, feedType:ContentFeedType, onProgress:OnProgressCallback)instead.
- Fixed issue where user could not query on a deleted post
- Fixed issue where user could not search community member using
displayName - Fixed issue where SDK updates
postSettingsfor community when user updates community but does not passpostSettingsvalues
- SDK Upgrade
- Fixed issue where error message is displayed while creating a reply to a comment
- Introduced real-time event for channel deletion
- Introduced ability to manage community post settings via SDK (i.e. 'Only Admins Can Post' or 'Approve Member Posts')
- Fixed issue where the replies were not updated in the comment
- Add new flag for postSetting to community to define minimum post requirements such as being an admin or requiring approval. This is applicable to post and create.
- Change of parameter name from
needApprovalOnPostCreationtopostSetting
Previous Version:
import { CommunityRepository } from '@amityco/js-sdk';
​
CommunityRepository.createCommunity({
displayName: string,
description?: string,
avatarFileId?: string,
categoryIds?: string[],
tags?: string[],
metadata?: Object,
isPublic?: boolean,
userIds?: string[],
});
New Version:
import { CommunityRepository } from '@amityco/js-sdk';
​
CommunityRepository.createCommunity({
displayName: string,
description?: string,
avatarFileId?: string,
categoryIds?: string[],
tags?: string[],
metadata?: Object,
isPublic?: boolean,
userIds?: string[],
postSetting?: string,
isOfficial?: boolean,
});
​
// Available value for postSettings
[
ONLY_ADMIN_CAN_POST,
ADMIN_REVIEW_POST_REQUIRED,
ANYONE_CAN_POST,
]
- Made channelId optional when creating new channels
- ChannelId parameter in
createChannelis now optional.
Previous Version:
import { ChannelRepository } from '@amityco/js-sdk';
/**
* Previous version
* *** channelId is mandatory field ***
* *** type: ['standard', 'private', 'live', 'community', 'conversation', 'broadcast'] ***
*/
ChannelRepository.createChannel({ channelId, type, displayName, avatarFileId, userIds, tags, metadata })
New Version:
import { ChannelRepository } from '@amityco/js-sdk';
/**
* New version
* *** channelId is now optional ***
* *** type: ['live', 'community', 'conversation', 'broadcast'] ***
*/
ChannelRepository.createChannel({ channelId?, type, displayName, avatarFileId, userIds, tags, metadata })
- Real time update of user deletion
- Add
reactionsCountinto the message model
- SDK Upgrade
- SDK Upgrade
- Update video post by adding/removing videos from the existing post (SDK only)
- Realtime events for comments and posts in User feed
- Support updating video post by adding/removing the video from the existing post
- No error prompts when SDK method is invoked without internet connection
- Unable to search for accent alphabet while using
CommunityRepository.getCommunityMembers
- Changed
apiRegionfor Singapore tosg - Query posts returns only five posts regardless of the limit
- Removed
typefield fromjoinChannel
joinChannelno longer accepts the type parameter
Previous Version:
import { ChannelRepository } from '@amityco/js-sdk';
const result = await ChannelRepository.joinChannel({ channelId: string, type: string });
New Version:
import { ChannelRepository } from '@amityco/js-sdk';
// “type†is no need anymore
const result = await ChannelRepository.joinChannel({ channelId: string });
- Error when subscribing to all community post and comment events
- SDK upgrade
- Create poll post now supports metadata parameter.
- Improvement of user searching for
getCommunityMembersmethod
- Custom post ranking in global feed
- Mention in Comment/Reply
- Follow with multiple
registerSession
- Get Post doesn't return
metadata - Edited post is not observed in real-time even though user subscribes to the post
- User observed duplicated set of l
oadingStatus: "loaded" - Post disappears when its comment is deleted
- SDK upgrade
- Introduce Social Realtime Events for seamless real-time data synchronization and collaboration across all connected devices.
Previous Version:
import Client from '@amityco/js-sdk';
Client.create({ apiKey, apiEndpoint });
New Version:
import Client from '@amityco/js-sdk';
Client.create({ apiKey, apiRegion })
// OR
Client.create({ apiKey, apiEndpoint, mqttEndpoint });
The changes are optional parameters, and developers can continue to use the existing parameters if they prefer.
- Create text, image, video, and file posts with the ability to mention other users
- New
assignRolesToUsersandremoveRolesFromUsersmethods for CommunityRepository - New
isGlobalBanproperty for User model to see if user is globally banned or not - Search community members by
CommunityRepository.getCommunityMembersmethod - Introduce support for assigning and removing multiples roles to members in community
- Introduce support for searching members in community
- Introduce support for mentioning users in post
- Add
isGlobalBanflag to user model
- Community Members now will correctly return paging token if there are more members (default: 20 members)
assignRolesToUsersandremoveRolesFromUserswill now acceptrolespayload as an arrayassignRoleToUsersandremoveRoleFromUserswill be deprecated- Change of parameter name from
assignRoleToUserstoassignRolesToUsers
import { CommunityRepository } from '@amityco/js-sdk'
​
​
// Previous version [deprecated]
CommunityRepository.assignRoleToUsers({ communityId: string, userIds: string[] });
​
​
// New version
CommunityRepository.assignRoleToUsers({ communityId: string, roles: string[], userIds: string[] });
- Change of parameter name from
removeRoleFromUserstoremoveRolesFromUsers
import { CommunityRepository } from '@amityco/js-sdk'
​
​
// Previous version [deprecated]
CommunityRepository.removeRoleToUsers({ communityId: string, userIds: string[] });
​
​
// New version
CommunityRepository.removeRoleToUsers({ communityId: string, roles: string[], userIds: string[] });
- Change function type of function from sync to async for
updatePost
- SDK upgrade
- SDK upgrade
- Introduce permanent deletion support for comments and posts, replacing the prior default of soft delete
- Add the mentioned users to the message model for the community/live group chat
- Send mention unread information to users/UIKit
- Fetch the list of members in the chat with the ability to search using the display name or user ID
- Add a tag feature to the post
- Add the chat setting into the network setting
- Cannot connect to client when user is unbanned
- Cannot connect to client when Web Socket gets disconnected
- Cannot fetch messages in chat
- Incorrect error code received when user is global banned
- Cannot load the next page in chatroom when scrolling up to the first message and new messages are received
- Cannot load the next page after reading all the messages in chat and then receiving more messages
- Sending a blocklisted word in a message will result to a syncing state instead of an error
- Add Web SDK license
- Expose channel errors to the user
- Fix incorrect positioning of messages sent in chat when sending multiple messages at once
- Expose global ban error to the user
- Expose connection errors to the user
- Minor enhancements and continuous improvement
- Live Collection does not fire events for additional pages when data is already in cache
- JoinChannels return value should be a promise
- Minor enhancements and continuous improvement
- Minor enhancements and continuous improvement
- Minor enhancements and continuous improvement
- Add explicit public flag is necessary when publishing org packages
- Add missing default build command
Last modified 2d ago