Skip to main content
Version: 5.4

Release notes

This page provides the release notes for WebPlanetKit 5.4.

WebPlanetKit 5.4

Release date: 2025-08-11

Support user types

  • We have added a feature that allows distinguishing user types defined by the application. This can be used when the application needs to alter behavior or UI configuration for each user type. For example, it can be used to differentiate between regular users and bot users.
  • You can define and use any value within the range of 1 to 9999.
  • Values starting from 10000 are used to differentiate agents provided by LINE Planet. For more information, refer to Agent call.
  • For more information on user types, refer to Setting the user type.

API

Added
  • PLANET_KIT_USER_TYPE enum Group call
  • UserTypeContainer class Group call
  • PeerInfo data class Group call
    • var userType: UserTypeContainer
  • ConferenceParams data class Group call
    • var customUserType?: number
  • START_FAIL_REASON enum 1-to-1 callGroup call
    • INVALID_CUSTOM_USER_TYPE: 'invalid_custom_user_type'
    • INTERNAL_INITIALIZATION_ERROR: 'internal_initialization_error'

Example code

  • Define the application user type and set it when joining a group call.
const SAMPLE_BOT_TYPE = 100;
const conferenceParams = {
...,
customUserType: SAMPLE_BOT_TYPE
};
planetKit.joinConference(conferenceParams)
.then(() => {
// Successfully joined a conference
})
.catch((joinConferenceError) => {
// If the value of `customUserType` is invalid, joining a conference will fail with the reason code `INVALID_CUSTOM_USER_TYPE`.
});
  • Implement actions to be processed according to the user type.
const onEvtPeerListUpdated = (peerListUpdatedParam) => {
const { addedPeers, removedPeers, totalPeersCount } = peerListUpdatedParam;

addedPeers.forEach((peer) => {
if (peer.userType.getCustomUserType() === SAMPLE_BOT_TYPE) {
console.log("Sample bot has joined.");
}
});

removedPeers.forEach((peer) => {
if (peer.userType.getCustomUserType() === SAMPLE_BOT_TYPE) {
console.log("Sample bot has left.");
}
});
};