diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKAi.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKAi.md
index bfe857bd9ca..2056616c771 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKAi.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKAi.md
@@ -1,7 +1,6 @@
---
title: RTKAi
sidebar_position: 1
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKChat.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKChat.md
index f0dc2d5d09f..b1fe62a500a 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKChat.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKChat.md
@@ -1,7 +1,6 @@
---
title: RTKChat
sidebar_position: 2
-web_core_version: 1.2.4
---
@@ -16,7 +15,6 @@ This is the chat module, which can be used to send and receive messages from the
* [new module.exports(context, chatSocketHandler, self, participants)](#new_module_RTKChat--module.exports_new)
* ~~[.messages](#module_RTKChat--module.exports+messages)~~
* [.telemetry](#module_RTKChat--module.exports+telemetry)
- * [.pinned](#module_RTKChat--module.exports+pinned)
* [.setMaxTextLimit(limit)](#module_RTKChat--module.exports+setMaxTextLimit)
* [.sendMessageInternal(message, [participantIds])](#module_RTKChat--module.exports+sendMessageInternal)
* [.sendTextMessageInternal(message, [peerIds])](#module_RTKChat--module.exports+sendTextMessageInternal)
@@ -33,15 +31,11 @@ This is the chat module, which can be used to send and receive messages from the
* [.editFileMessage(messageId, file)](#module_RTKChat--module.exports+editFileMessage)
* [.editMessage(messageId, message)](#module_RTKChat--module.exports+editMessage)
* [.deleteMessage(messageId)](#module_RTKChat--module.exports+deleteMessage)
- * ~~[.getMessagesByUser(userId)](#module_RTKChat--module.exports+getMessagesByUser)~~
- * ~~[.getMessagesByType(type)](#module_RTKChat--module.exports+getMessagesByType)~~
* [.pin(id)](#module_RTKChat--module.exports+pin)
* [.unpin(id)](#module_RTKChat--module.exports+unpin)
* [.fetchPublicMessages(options)](#module_RTKChat--module.exports+fetchPublicMessages)
* [.fetchPrivateMessages(options)](#module_RTKChat--module.exports+fetchPrivateMessages)
* [.fetchPinnedMessages(options)](#module_RTKChat--module.exports+fetchPinnedMessages)
- * ~~[.getMessages(timeStamp, size, reversed, [offset])](#module_RTKChat--module.exports+getMessages)~~
- * ~~[.searchMessages(query, [filters])](#module_RTKChat--module.exports+searchMessages)~~
@@ -68,12 +62,6 @@ This is the chat module, which can be used to send and receive messages from the
#### module.exports.telemetry
**Kind**: instance property of [module.exports](#exp_module_RTKChat--module.exports)
-
-
-#### module.exports.pinned
-**Kind**: instance property of [module.exports](#exp_module_RTKChat--module.exports)
-**Deprecated.**: This property is deprecated. Please use `fetchPinnedMessages()` instead.
-Returns an array of pinned messages.
#### module.exports.setMaxTextLimit(limit)
@@ -244,28 +232,6 @@ object.
| --- | --- | --- |
| messageId | string | Id of the message to delete. |
-
-
-#### ~~module.exports.getMessagesByUser(userId)~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RTKChat--module.exports)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| userId | string | The user id of the user that sent the message. |
-
-
-
-#### ~~module.exports.getMessagesByType(type)~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RTKChat--module.exports)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| type | 'text' \| 'image' \| 'file' \| 'custom' \| 'poll' | 'text', 'image', 'file', 'custom', or 'poll'. |
-
#### module.exports.pin(id)
@@ -321,29 +287,3 @@ Fetches pinned messages with pagination.
| --- | --- | --- |
| options | FetchMessageOptions | Configuration options for fetching pinned messages, including timestamp, limit, and direction. |
-
-
-#### ~~module.exports.getMessages(timeStamp, size, reversed, [offset])~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RTKChat--module.exports)
-
-| Param | Type | Default |
-| --- | --- | --- |
-| timeStamp | number | |
-| size | number | |
-| reversed | boolean | |
-| [offset] | number | 0 |
-
-
-
-#### ~~module.exports.searchMessages(query, [filters])~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RTKChat--module.exports)
-
-| Param | Type |
-| --- | --- |
-| query | string |
-| [filters] | SearchFilters |
-
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKConnectedMeetings.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKConnectedMeetings.md
index 4f7519ff808..64d81c75677 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKConnectedMeetings.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKConnectedMeetings.md
@@ -1,7 +1,6 @@
---
title: RTKConnectedMeetings
sidebar_position: 4
-web_core_version: 1.2.4
---
@@ -14,7 +13,7 @@ This consists of the methods to facilitate connected meetings
* [RTKConnectedMeetings](#module_RTKConnectedMeetings)
* [module.exports](#exp_module_RTKConnectedMeetings--module.exports) ⏏
* [new module.exports(context)](#new_module_RTKConnectedMeetings--module.exports_new)
- * [.getRTKConnectedMeetings()](#module_RTKConnectedMeetings--module.exports+getRTKConnectedMeetings)
+ * [.getConnectedMeetings()](#module_RTKConnectedMeetings--module.exports+getConnectedMeetings)
* [.createMeetings(request)](#module_RTKConnectedMeetings--module.exports+createMeetings)
* [.updateMeetings(request)](#module_RTKConnectedMeetings--module.exports+updateMeetings)
* [.deleteMeetings(meetingIds)](#module_RTKConnectedMeetings--module.exports+deleteMeetings)
@@ -33,9 +32,9 @@ This consists of the methods to facilitate connected meetings
| --- | --- |
| context | Context |
-
+
-#### module.exports.getRTKConnectedMeetings()
+#### module.exports.getConnectedMeetings()
get connected meeting state
**Kind**: instance method of [module.exports](#exp_module_RTKConnectedMeetings--module.exports)
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKLivestream.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKLivestream.md
index 4d2d4d56bab..1588b78de49 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKLivestream.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKLivestream.md
@@ -1,7 +1,6 @@
---
title: RTKLivestream
sidebar_position: 5
-web_core_version: 1.2.4
---
@@ -16,7 +15,7 @@ to start/stop live streams.
* [module.exports](#exp_module_RTKLivestream--module.exports) ⏏
* [new module.exports(context, self)](#new_module_RTKLivestream--module.exports_new)
* [.telemetry](#module_RTKLivestream--module.exports+telemetry)
- * [.setRTKLivestreamState(livestreamState)](#module_RTKLivestream--module.exports+setRTKLivestreamState)
+ * [.setLivestreamState(livestreamState)](#module_RTKLivestream--module.exports+setLivestreamState)
* [.start([livestreamConfig])](#module_RTKLivestream--module.exports+start)
* [.stop()](#module_RTKLivestream--module.exports+stop)
@@ -37,9 +36,9 @@ to start/stop live streams.
#### module.exports.telemetry
**Kind**: instance property of [module.exports](#exp_module_RTKLivestream--module.exports)
-
+
-#### module.exports.setRTKLivestreamState(livestreamState)
+#### module.exports.setLivestreamState(livestreamState)
**Kind**: instance method of [module.exports](#exp_module_RTKLivestream--module.exports)
| Param | Type |
@@ -55,7 +54,7 @@ Starts livestreaming the meeting.
| Param | Type |
| --- | --- |
-| [livestreamConfig] | StartRTKLivestreamConfig |
+| [livestreamConfig] | StartLivestreamConfig |
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKMeta.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKMeta.md
index 8a3447521df..57aebeda4f1 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKMeta.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKMeta.md
@@ -1,7 +1,6 @@
---
title: RTKMeta
sidebar_position: 6
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipant.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipant.md
index 5ab88c872e9..537f615060c 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipant.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipant.md
@@ -1,7 +1,6 @@
---
title: RTKParticipant
sidebar_position: 7
-web_core_version: 1.2.4
---
@@ -15,7 +14,8 @@ present in the `meeting.participants` object. For example,
const participant1 = meeting.participants.active.get(participantId);
const participant2 = meeting.participants.joined.get(participantId);
const participant3 = meeting.participants.active.toArray()[0];
-const participant4 = meeting.participants.active.toArray().filter((p) => p.name === 'John');
+const participant4 = meeting.participants.active.toArray()
+ .filter((p) => p.name === 'John');
```
@@ -26,8 +26,7 @@ const participant4 = meeting.participants.active.toArray().filter((p) => p.name
* [.userId](#module_RTKParticipant--module.exports+userId)
* [.name](#module_RTKParticipant--module.exports+name)
* [.picture](#module_RTKParticipant--module.exports+picture)
- * [.customRTKParticipantId](#module_RTKParticipant--module.exports+customRTKParticipantId)
- * ~~[.clientSpecificId](#module_RTKParticipant--module.exports+clientSpecificId)~~
+ * [.customParticipantId](#module_RTKParticipant--module.exports+customParticipantId)
* [.device](#module_RTKParticipant--module.exports+device)
* [.videoTrack](#module_RTKParticipant--module.exports+videoTrack)
* [.audioTrack](#module_RTKParticipant--module.exports+audioTrack)
@@ -66,7 +65,7 @@ const participant4 = meeting.participants.active.toArray().filter((p) => p.name
| Param | Type |
| --- | --- |
| context | Context |
-| participant | IRTKParticipant |
+| participant | IParticipant |
| self | Self |
| roomSocket | RoomSocketHandler |
@@ -95,17 +94,11 @@ The name of the participant.
The picture of the participant.
**Kind**: instance property of [module.exports](#exp_module_RTKParticipant--module.exports)
-
+
-#### module.exports.customRTKParticipantId
+#### module.exports.customParticipantId
The custom id of the participant set during Add RTKParticipant REST API
-**Kind**: instance property of [module.exports](#exp_module_RTKParticipant--module.exports)
-
-
-#### ~~module.exports.clientSpecificId~~
-***Deprecated***
-
**Kind**: instance property of [module.exports](#exp_module_RTKParticipant--module.exports)
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipantMap.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipantMap.md
index f10720836d0..9d428ff0298 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipantMap.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipantMap.md
@@ -1,7 +1,6 @@
---
title: RTKParticipantMap
sidebar_position: 20
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipants.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipants.md
index 6cc9cfa343f..9193341cf75 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipants.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipants.md
@@ -1,7 +1,6 @@
---
title: RTKParticipants
sidebar_position: 8
-web_core_version: 1.2.4
---
@@ -21,7 +20,7 @@ It consists of 4 maps:
* [new module.exports(context, self, roomSocketHandler)](#new_module_RTKParticipants--module.exports_new)
* [.waitlisted](#module_RTKParticipants--module.exports+waitlisted)
* [.joined](#module_RTKParticipants--module.exports+joined)
- * ~~[.active](#module_RTKParticipants--module.exports+active)~~
+ * [.active](#module_RTKParticipants--module.exports+active)
* [.videoSubscribed](#module_RTKParticipants--module.exports+videoSubscribed)
* [.audioSubscribed](#module_RTKParticipants--module.exports+audioSubscribed)
* [.pinned](#module_RTKParticipants--module.exports+pinned)
@@ -33,9 +32,9 @@ It consists of 4 maps:
* [.lastActiveSpeaker](#module_RTKParticipants--module.exports+lastActiveSpeaker)
* [.selectedPeers](#module_RTKParticipants--module.exports+selectedPeers)
* [.count](#module_RTKParticipants--module.exports+count)
- * [.maxActiveRTKParticipantsCount](#module_RTKParticipants--module.exports+maxActiveRTKParticipantsCount)
+ * [.maxActiveParticipantsCount](#module_RTKParticipants--module.exports+maxActiveParticipantsCount)
* [.pageCount](#module_RTKParticipants--module.exports+pageCount)
- * [.setMaxActiveRTKParticipantsCount(limit)](#module_RTKParticipants--module.exports+setMaxActiveRTKParticipantsCount)
+ * [.setMaxActiveParticipantsCount(limit)](#module_RTKParticipants--module.exports+setMaxActiveParticipantsCount)
* [.acceptWaitingRoomRequest(id)](#module_RTKParticipants--module.exports+acceptWaitingRoomRequest)
* [.acceptAllWaitingRoomRequest(userIds)](#module_RTKParticipants--module.exports+acceptAllWaitingRoomRequest)
* [.rejectWaitingRoomRequest(id)](#module_RTKParticipants--module.exports+rejectWaitingRoomRequest)
@@ -45,13 +44,10 @@ It consists of 4 maps:
* [.setPage(page)](#module_RTKParticipants--module.exports+setPage)
* [.disableAllAudio(allowUnmute)](#module_RTKParticipants--module.exports+disableAllAudio)
* [.disableAllVideo()](#module_RTKParticipants--module.exports+disableAllVideo)
- * ~~[.disableAudio(participantId)](#module_RTKParticipants--module.exports+disableAudio)~~
- * ~~[.disableVideo(participantId)](#module_RTKParticipants--module.exports+disableVideo)~~
- * ~~[.kick(participantId)](#module_RTKParticipants--module.exports+kick)~~
* [.kickAll()](#module_RTKParticipants--module.exports+kickAll)
* [.broadcastMessage(type, payload, target)](#module_RTKParticipants--module.exports+broadcastMessage)
* [.getAllJoinedPeers(searchQuery, limit, offset)](#module_RTKParticipants--module.exports+getAllJoinedPeers)
- * [.getRTKParticipantsInMeetingPreJoin()](#module_RTKParticipants--module.exports+getRTKParticipantsInMeetingPreJoin)
+ * [.getParticipantsInMeetingPreJoin()](#module_RTKParticipants--module.exports+getParticipantsInMeetingPreJoin)
@@ -85,8 +81,8 @@ Returns a list of all participants in the meeting.
**Kind**: instance property of [module.exports](#exp_module_RTKParticipants--module.exports)
-#### ~~module.exports.active~~
-***Deprecated***
+#### module.exports.active
+Returns a list of participants whose streams are currently consumed.
**Kind**: instance property of [module.exports](#exp_module_RTKParticipants--module.exports)
@@ -163,9 +159,9 @@ Keeps a list of all participants who have been present in the selected peers lis
Returns the number of participants who are joined in the meeting.
**Kind**: instance property of [module.exports](#exp_module_RTKParticipants--module.exports)
-
+
-#### module.exports.maxActiveRTKParticipantsCount
+#### module.exports.maxActiveParticipantsCount
Returns the maximum number of participants that can be present in
the active map.
@@ -177,9 +173,9 @@ Returns the number of pages that are available in the meeting in PAGINATED mode.
If the meeting is in ACTIVE_GRID mode, this value will be 0.
**Kind**: instance property of [module.exports](#exp_module_RTKParticipants--module.exports)
-
+
-#### module.exports.setMaxActiveRTKParticipantsCount(limit)
+#### module.exports.setMaxActiveParticipantsCount(limit)
Updates the maximum number of participants that are populated in
the active map.
@@ -287,39 +283,6 @@ Disables audio for all participants in the meeting.
Disables video for all participants in the meeting.
**Kind**: instance method of [module.exports](#exp_module_RTKParticipants--module.exports)
-
-
-#### ~~module.exports.disableAudio(participantId)~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RTKParticipants--module.exports)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| participantId | string | ID of participant to be muted. |
-
-
-
-#### ~~module.exports.disableVideo(participantId)~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RTKParticipants--module.exports)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| participantId | string | ID of participant to be muted. |
-
-
-
-#### ~~module.exports.kick(participantId)~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RTKParticipants--module.exports)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| participantId | string | ID of participant to be kicked. |
-
#### module.exports.kickAll()
@@ -356,9 +319,9 @@ instead
| limit | number |
| offset | number |
-
+
-#### module.exports.getRTKParticipantsInMeetingPreJoin()
+#### module.exports.getParticipantsInMeetingPreJoin()
Returns all peers currently in the room, is a non paginated call
and should only be used if you are in a non room joined state,
if in a joined group call, use `meeting.participants.joined`
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPermissionsPreset.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPermissionsPreset.md
index e8da972e0b7..ce9a7fde2d7 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPermissionsPreset.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPermissionsPreset.md
@@ -1,7 +1,6 @@
---
title: RTKPermissionsPreset
sidebar_position: 9
-web_core_version: 1.2.4
---
@@ -12,46 +11,32 @@ The PermissionPreset class represents the meeting permissions for the current pa
* [PermissionPreset](#module_PermissionPreset)
- * _instance_
- * [.stageEnabled](#module_PermissionPreset+stageEnabled)
- * [.stageAccess](#module_PermissionPreset+stageAccess)
- * [.acceptWaitingRequests](#module_PermissionPreset+acceptWaitingRequests)
- * [.requestProduceVideo](#module_PermissionPreset+requestProduceVideo)
- * [.requestProduceAudio](#module_PermissionPreset+requestProduceAudio)
- * [.requestProduceScreenshare](#module_PermissionPreset+requestProduceScreenshare)
- * [.canAllowParticipantAudio](#module_PermissionPreset+canAllowParticipantAudio)
- * [.canAllowParticipantScreensharing](#module_PermissionPreset+canAllowParticipantScreensharing)
- * [.canAllowParticipantVideo](#module_PermissionPreset+canAllowParticipantVideo)
- * [.canDisableParticipantAudio](#module_PermissionPreset+canDisableParticipantAudio)
- * [.canDisableParticipantVideo](#module_PermissionPreset+canDisableParticipantVideo)
- * [.kickParticipant](#module_PermissionPreset+kickParticipant)
- * [.pinParticipant](#module_PermissionPreset+pinParticipant)
- * [.canRecord](#module_PermissionPreset+canRecord)
- * ~~[.waitingRoomType](#module_PermissionPreset+waitingRoomType)~~
- * [.waitingRoomBehaviour](#module_PermissionPreset+waitingRoomBehaviour)
- * [.plugins](#module_PermissionPreset+plugins)
- * [.polls](#module_PermissionPreset+polls)
- * ~~[.produceVideo](#module_PermissionPreset+produceVideo)~~
- * ~~[.requestProduce](#module_PermissionPreset+requestProduce)~~
- * [.canProduceVideo](#module_PermissionPreset+canProduceVideo)
- * ~~[.produceScreenshare](#module_PermissionPreset+produceScreenshare)~~
- * [.canProduceScreenshare](#module_PermissionPreset+canProduceScreenshare)
- * ~~[.produceAudio](#module_PermissionPreset+produceAudio)~~
- * [.canProduceAudio](#module_PermissionPreset+canProduceAudio)
- * [.chatPublic](#module_PermissionPreset+chatPublic)
- * [.chatPrivate](#module_PermissionPreset+chatPrivate)
- * [.hiddenParticipant](#module_PermissionPreset+hiddenParticipant)
- * [.showParticipantList](#module_PermissionPreset+showParticipantList)
- * ~~[.canChangeParticipantRole](#module_PermissionPreset+canChangeParticipantRole)~~
- * [.canChangeParticipantPermissions](#module_PermissionPreset+canChangeParticipantPermissions)
- * ~~[.canChangeTheme](#module_PermissionPreset+canChangeTheme)~~
- * ~~[.canPresent](#module_PermissionPreset+canPresent)~~
- * ~~[.acceptPresentRequests](#module_PermissionPreset+acceptPresentRequests)~~
- * ~~[.maxScreenShareCount](#module_PermissionPreset+maxScreenShareCount)~~
- * [.canLivestream](#module_PermissionPreset+canLivestream)
- * _static_
- * [.fromResponse()](#module_PermissionPreset.fromResponse)
- * [.default()](#module_PermissionPreset.default)
+ * [.stageEnabled](#module_PermissionPreset+stageEnabled)
+ * [.stageAccess](#module_PermissionPreset+stageAccess)
+ * [.acceptWaitingRequests](#module_PermissionPreset+acceptWaitingRequests)
+ * [.requestProduceVideo](#module_PermissionPreset+requestProduceVideo)
+ * [.requestProduceAudio](#module_PermissionPreset+requestProduceAudio)
+ * [.requestProduceScreenshare](#module_PermissionPreset+requestProduceScreenshare)
+ * [.canAllowParticipantAudio](#module_PermissionPreset+canAllowParticipantAudio)
+ * [.canAllowParticipantScreensharing](#module_PermissionPreset+canAllowParticipantScreensharing)
+ * [.canAllowParticipantVideo](#module_PermissionPreset+canAllowParticipantVideo)
+ * [.canDisableParticipantAudio](#module_PermissionPreset+canDisableParticipantAudio)
+ * [.canDisableParticipantVideo](#module_PermissionPreset+canDisableParticipantVideo)
+ * [.kickParticipant](#module_PermissionPreset+kickParticipant)
+ * [.pinParticipant](#module_PermissionPreset+pinParticipant)
+ * [.canRecord](#module_PermissionPreset+canRecord)
+ * [.waitingRoomBehaviour](#module_PermissionPreset+waitingRoomBehaviour)
+ * [.plugins](#module_PermissionPreset+plugins)
+ * [.polls](#module_PermissionPreset+polls)
+ * [.canProduceVideo](#module_PermissionPreset+canProduceVideo)
+ * [.canProduceScreenshare](#module_PermissionPreset+canProduceScreenshare)
+ * [.canProduceAudio](#module_PermissionPreset+canProduceAudio)
+ * [.chatPublic](#module_PermissionPreset+chatPublic)
+ * [.chatPrivate](#module_PermissionPreset+chatPrivate)
+ * [.hiddenParticipant](#module_PermissionPreset+hiddenParticipant)
+ * [.showParticipantList](#module_PermissionPreset+showParticipantList)
+ * [.canChangeParticipantPermissions](#module_PermissionPreset+canChangeParticipantPermissions)
+ * [.canLivestream](#module_PermissionPreset+canLivestream)
@@ -64,7 +49,7 @@ If `true`, stage management is available for the participant.
### meeting.self.permissions.stageAccess
The `stageAccess` property dictates how a user interacts with the stage.
-There possible values are `ALLOWED`, `NOT_ALLOWED`, `CAN_REQUEST`;
+The possible values are `ALLOWED`, `NOT_ALLOWED`, `CAN_REQUEST`;
**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
@@ -151,12 +136,6 @@ If `true`, participant can pin a participant in the meeting.
The `canRecord` returns boolean value.
If `true`, participant can record the meeting.
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.waitingRoomType~~
-***Deprecated***
-
**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
@@ -179,18 +158,6 @@ there are 2 permissions with boolean values, `canStart` and `canClose`.
The `polls` tells if the participant can use polls.
There are 3 permissions with boolean values, `canCreate`, `canVote`, `canViewResults`
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.produceVideo~~
-***Deprecated***
-
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.requestProduce~~
-***Deprecated***
-
**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
@@ -198,12 +165,6 @@ There are 3 permissions with boolean values, `canCreate`, `canVote`, `canViewRes
The `canProduceVideo` shows permissions for enabling video.
There possible values are `ALLOWED`, `NOT_ALLOWED`, `CAN_REQUEST`
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.produceScreenshare~~
-***Deprecated***
-
**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
@@ -211,12 +172,6 @@ There possible values are `ALLOWED`, `NOT_ALLOWED`, `CAN_REQUEST`
The `canProduceScreenshare` shows permissions for sharing screen.
There possible values are `ALLOWED`, `NOT_ALLOWED`, `CAN_REQUEST`
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.produceAudio~~
-***Deprecated***
-
**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
@@ -259,12 +214,6 @@ If `true`, participant is hidden.
The `showParticipantList` returns boolean value.
If `true`, participant list can be shown to the participant.
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.canChangeParticipantRole~~
-***Deprecated***
-
**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
@@ -272,30 +221,6 @@ If `true`, participant list can be shown to the participant.
The `canChangeParticipantPermissions` returns boolean value.
If `true`, allow changing the participants' permissions.
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.canChangeTheme~~
-***Deprecated***
-
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.canPresent~~
-***Deprecated***
-
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.acceptPresentRequests~~
-***Deprecated***
-
-**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### ~~meeting.self.permissions.maxScreenShareCount~~
-***Deprecated***
-
**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
@@ -303,13 +228,3 @@ If `true`, allow changing the participants' permissions.
Livestream
**Kind**: instance property of [PermissionPreset](#module_PermissionPreset)
-
-
-### meeting.self.permissions.fromResponse()
-**Kind**: static method of [PermissionPreset](#module_PermissionPreset)
-**Deprecated.**: Use init()
-
-
-### meeting.self.permissions.default()
-**Kind**: static method of [PermissionPreset](#module_PermissionPreset)
-**Deprecated.**: Use init()
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPip.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPip.md
index 72747a12f6b..f73d3572f02 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPip.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPip.md
@@ -1,7 +1,6 @@
---
title: RTKPip
sidebar_position: 11
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPlugin.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPlugin.md
index 68d9b48f76f..3493f0ff7cb 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPlugin.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPlugin.md
@@ -1,7 +1,6 @@
---
title: RTKPlugin
sidebar_position: 10
-web_core_version: 1.2.4
---
@@ -18,138 +17,53 @@ const plugin2 = meeting.plugins.all.get(pluginId);
* [RTKPlugin](#module_RTKPlugin)
- * [module.exports](#exp_module_RTKPlugin--module.exports) ⏏
- * [new module.exports(context, plugin, pluginSocketHandler, self, participants, chat, meetingTitle)](#new_module_RTKPlugin--module.exports_new)
- * [.telemetry](#module_RTKPlugin--module.exports+telemetry)
- * [.sendIframeEvent(message)](#module_RTKPlugin--module.exports+sendIframeEvent)
- * [.handleIframeMessage(iframeMessage)](#module_RTKPlugin--module.exports+handleIframeMessage)
- * [.sendData(payload)](#module_RTKPlugin--module.exports+sendData)
- * [.removeRTKPluginView(viewId)](#module_RTKPlugin--module.exports+removeRTKPluginView)
- * [.addRTKPluginView(iframe, viewId)](#module_RTKPlugin--module.exports+addRTKPluginView)
- * [.setActive(active)](#module_RTKPlugin--module.exports+setActive)
- * [.activateForSelf()](#module_RTKPlugin--module.exports+activateForSelf)
- * [.deactivateForSelf()](#module_RTKPlugin--module.exports+deactivateForSelf)
- * ~~[.enable()](#module_RTKPlugin--module.exports+enable)~~
- * ~~[.disable()](#module_RTKPlugin--module.exports+disable)~~
- * [.activate()](#module_RTKPlugin--module.exports+activate)
- * [.deactivate()](#module_RTKPlugin--module.exports+deactivate)
-
-
-
-### module.exports ⏏
-**Kind**: Exported class
-
-
-#### new module.exports(context, plugin, pluginSocketHandler, self, participants, chat, meetingTitle)
+ * [.component](#module_RTKPlugin+component)
+ * [.telemetry](#module_RTKPlugin+telemetry)
+ * [.activePluginsStore](#module_RTKPlugin+activePluginsStore)
+ * [.activateForSelf()](#module_RTKPlugin+activateForSelf)
+ * [.deactivateForSelf()](#module_RTKPlugin+deactivateForSelf)
+ * [.activate()](#module_RTKPlugin+activate)
+ * [.deactivate()](#module_RTKPlugin+deactivate)
-| Param | Type |
-| --- | --- |
-| context | Context |
-| plugin | RTKPluginResponse |
-| pluginSocketHandler | RTKPluginSocketHandler |
-| self | Self |
-| participants | Participants |
-| chat | Chat |
-| meetingTitle | string |
+
-
+### plugin.component
+The component for this plugin, as provided in the plugin config.
-#### module.exports.telemetry
-**Kind**: instance property of [module.exports](#exp_module_RTKPlugin--module.exports)
-
+**Kind**: instance property of [RTKPlugin](#module_RTKPlugin)
+
-#### module.exports.sendIframeEvent(message)
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
+### plugin.telemetry
+**Kind**: instance property of [RTKPlugin](#module_RTKPlugin)
+
-| Param | Type | Description |
-| --- | --- | --- |
-| message | RTKPluginIframeMessage | Socket message forwarded to this plugin. |
-
-
-
-#### module.exports.handleIframeMessage(iframeMessage)
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
+### plugin.activePluginsStore
+**Kind**: instance property of [RTKPlugin](#module_RTKPlugin)
| Param | Type |
| --- | --- |
-| iframeMessage | RTKPluginIframeMessage |
-
-
-
-#### module.exports.sendData(payload)
-This method is used to send arbitrary data to the plugin.
-
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| payload | SendDataOptions | The payload that you want to send inside the plugin. |
-| payload.eventName | string | Name of the event. This is used to listen for the event in plugin SDK. |
-| payload.data | any | Data you wish to emit. It can assume any data type. |
-
-
-
-#### module.exports.removeRTKPluginView(viewId)
-This method is used for cleaning up event listeners attached to an iframe. It must
-be used before the iframe is removed from the DOM.
-
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| viewId | string | "default" | ID of the view corresponding to this iframe. Default is 'default'. |
-
-
-
-#### module.exports.addRTKPluginView(iframe, viewId)
-This method adds the communication layer between the plugin inside the iframe
-and the core application (meeting object) in the main window.
-
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| iframe | HTMLIFrameElement \| ReactNativeWebView | | Iframe element to display this plugin. |
-| viewId | string | "default" | ID of the view corresponding to this iframe. Default is 'default'. |
-
-
-
-#### module.exports.setActive(active)
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
-| Param | Type |
-| --- | --- |
-| active | boolean |
-
-
-
-#### module.exports.activateForSelf()
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
-
-#### module.exports.deactivateForSelf()
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
-
-#### ~~module.exports.enable()~~
-***Deprecated***
+| context | Context |
+| config | ClientPluginConfig |
+| activePluginsStore | Store |
+| self | Self |
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
+
-#### ~~module.exports.disable()~~
-***Deprecated***
+### plugin.activateForSelf()
+**Kind**: instance method of [RTKPlugin](#module_RTKPlugin)
+
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
+### plugin.deactivateForSelf()
+**Kind**: instance method of [RTKPlugin](#module_RTKPlugin)
+
-#### module.exports.activate()
+### plugin.activate()
Activate this plugin for all participants.
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
-
+**Kind**: instance method of [RTKPlugin](#module_RTKPlugin)
+
-#### module.exports.deactivate()
+### plugin.deactivate()
Deactivate this plugin for all participants.
-**Kind**: instance method of [module.exports](#exp_module_RTKPlugin--module.exports)
+**Kind**: instance method of [RTKPlugin](#module_RTKPlugin)
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPlugins.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPlugins.md
index 8ea2b948698..9ee0940f72a 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPlugins.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPlugins.md
@@ -1,7 +1,6 @@
---
title: RTKPlugins
sidebar_position: 12
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPolls.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPolls.md
index 95f20dbb49f..90cdc54c7e2 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKPolls.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKPolls.md
@@ -1,7 +1,6 @@
---
title: RTKPolls
sidebar_position: 13
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKRecording.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKRecording.md
index 4b2dd3b6116..42cbed79726 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKRecording.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKRecording.md
@@ -1,7 +1,6 @@
---
title: RTKRecording
sidebar_position: 14
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKSelf.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKSelf.md
index aa4a71840ea..08dbd3aabb2 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKSelf.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKSelf.md
@@ -1,7 +1,6 @@
---
title: RTKSelf
sidebar_position: 15
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKSelfMedia.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKSelfMedia.md
index 9e2d6335663..bdefb9b2eea 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKSelfMedia.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKSelfMedia.md
@@ -1,7 +1,6 @@
---
title: RTKSelfMedia
sidebar_position: 16
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKStage.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKStage.md
index 787b7778e4e..b22ea4e4219 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKStage.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKStage.md
@@ -1,7 +1,6 @@
---
title: RTKStage
sidebar_position: 17
-web_core_version: 1.2.4
---
@@ -78,7 +77,7 @@ Method to cancel a previous RTKStage join request
Method to grant access to RTKStage.
This can be in response to a RTKStage Join request but it can be called on other users as well
-`permissions.acceptRTKStageRequests` privilege required
+`permissions.acceptStageRequests` privilege required
**Kind**: instance method of [module.exports](#exp_module_RTKStage--module.exports)
@@ -109,7 +108,7 @@ to call this method
#### module.exports.kick(userIds)
Method to kick a user off the stage
-`permissions.acceptRTKStageRequests` privilege required
+`permissions.acceptStageRequests` privilege required
**Kind**: instance method of [module.exports](#exp_module_RTKStage--module.exports)
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKStore.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKStore.md
index c27dd5a9443..f46defe3663 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKStore.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKStore.md
@@ -1,7 +1,6 @@
---
title: RTKStore
sidebar_position: 18
-web_core_version: 1.2.4
---
@@ -14,7 +13,7 @@ The store can be accessed from the `meeting.stores` module.
**Returns**: An instance of RTKStore.
**Example**
```js
-const handRaiseRTKStore = meeting.stores.stores.get('handRaise');
+const handRaiseStore = meeting.stores.stores.get('handRaise');
```
* [RTKStore](#module_RTKStore) ⇒
@@ -27,6 +26,7 @@ const handRaiseRTKStore = meeting.stores.stores.get('handRaise');
* [.bulkDelete(data)](#module_RTKStore--module.exports+bulkDelete) ⇒ Promise.<void>
* [.get(key)](#module_RTKStore--module.exports+get) ⇒ any
* [.getAll()](#module_RTKStore--module.exports+getAll) ⇒ RTKStoreData
+ * [.clear()](#module_RTKStore--module.exports+clear)
* [.updateRateLimits(num, period)](#module_RTKStore--module.exports+updateRateLimits)
* [.updateBulkRateLimits(num, period)](#module_RTKStore--module.exports+updateBulkRateLimits)
* [.subscribe(key, cb)](#module_RTKStore--module.exports+subscribe) ⇒ void
@@ -45,7 +45,7 @@ const handRaiseRTKStore = meeting.stores.stores.get('handRaise');
| --- | --- |
| args | Object |
| args.name | string |
-| args.socketHandler | PluginSocketHandler |
+| args.socketHandler | RTKStoresSocketHandler |
| args.meetingId | string |
@@ -137,6 +137,12 @@ Returns the entire store.
**Kind**: instance method of [module.exports](#exp_module_RTKStore--module.exports)
**Returns**: RTKStoreData - An instance of RTKStoreData.
+
+
+#### module.exports.clear()
+Clears all data in the store.
+
+**Kind**: instance method of [module.exports](#exp_module_RTKStore--module.exports)
#### module.exports.updateRateLimits(num, period)
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RTKThemePreset.md b/src/content/docs/realtime/realtimekit/core/api-reference/RTKThemePreset.md
index 88539296c89..58727d1a939 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RTKThemePreset.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RTKThemePreset.md
@@ -1,7 +1,6 @@
---
title: RTKThemePreset
sidebar_position: 19
-web_core_version: 1.2.4
---
diff --git a/src/content/docs/realtime/realtimekit/core/api-reference/RealtimeKitClient.md b/src/content/docs/realtime/realtimekit/core/api-reference/RealtimeKitClient.md
index 1afafcb4fd4..89a10c67c66 100644
--- a/src/content/docs/realtime/realtimekit/core/api-reference/RealtimeKitClient.md
+++ b/src/content/docs/realtime/realtimekit/core/api-reference/RealtimeKitClient.md
@@ -1,7 +1,6 @@
---
title: RealtimeKitClient
sidebar_position: 3
-web_core_version: 1.2.4
---
@@ -29,8 +28,6 @@ named `meeting`.
* [.__internals__](#module_RealtimeKitClient--module.exports+__internals__)
* [.join()](#module_RealtimeKitClient--module.exports+join)
* [.leave()](#module_RealtimeKitClient--module.exports+leave)
- * ~~[.joinRoom()](#module_RealtimeKitClient--module.exports+joinRoom)~~
- * ~~[.leaveRoom([state])](#module_RealtimeKitClient--module.exports+leaveRoom)~~
* _static_
* [.initMedia([options], [skipAwaits], [cachedUserDetails])](#module_RealtimeKitClient--module.exports.initMedia)
* [.init(options)](#module_RealtimeKitClient--module.exports.init)
@@ -131,23 +128,6 @@ is joined successfully.
The `leave()` method can be used to leave a meeting.
**Kind**: instance method of [module.exports](#exp_module_RealtimeKitClient--module.exports)
-
-
-#### ~~module.exports.joinRoom()~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RealtimeKitClient--module.exports)
-
-
-#### ~~module.exports.leaveRoom([state])~~
-***Deprecated***
-
-**Kind**: instance method of [module.exports](#exp_module_RealtimeKitClient--module.exports)
-
-| Param | Type |
-| --- | --- |
-| [state] | LeaveRoomState |
-
#### module.exports.initMedia([options], [skipAwaits], [cachedUserDetails])