cloudflare · ravindra-cloudflare · Jul 20, 2026 · Jul 20, 2026
@@ -1,7 +1,6 @@
 ---
 title: RTKAi
 sidebar_position: 1
-web_core_version: 1.2.4
 ---
 
 <!-- Auto Generated Below -->

@@ -1,7 +1,6 @@
 ---
 title: RTKChat
 sidebar_position: 2
-web_core_version: 1.2.4
 ---
 
 <!-- Auto Generated Below -->
@@ -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)~~
 
 <a name="exp_module_RTKChat--module.exports"></a>
 
@@ -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 [<code>module.exports</code>](#exp_module_RTKChat--module.exports)  
-<a name="module_RTKChat--module.exports+pinned"></a>
-
-#### module.exports.pinned
-**Kind**: instance property of [<code>module.exports</code>](#exp_module_RTKChat--module.exports)  
-**Deprecated.**: This property is deprecated. Please use `fetchPinnedMessages()` instead.
-Returns an array of pinned messages.  
 <a name="module_RTKChat--module.exports+setMaxTextLimit"></a>
 
 #### module.exports.setMaxTextLimit(limit)
@@ -244,28 +232,6 @@ object.
 | --- | --- | --- |
 | messageId | <code>string</code> | Id of the message to delete. |
 
-<a name="module_RTKChat--module.exports+getMessagesByUser"></a>
-
-#### ~~module.exports.getMessagesByUser(userId)~~
-***Deprecated***
-
-**Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKChat--module.exports)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| userId | <code>string</code> | The user id of the user that sent the message. |
-
-<a name="module_RTKChat--module.exports+getMessagesByType"></a>
-
-#### ~~module.exports.getMessagesByType(type)~~
-***Deprecated***
-
-**Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKChat--module.exports)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| type | <code>&#x27;text&#x27;</code> \| <code>&#x27;image&#x27;</code> \| <code>&#x27;file&#x27;</code> \| <code>&#x27;custom&#x27;</code> \| <code>&#x27;poll&#x27;</code> | 'text', 'image', 'file', 'custom', or 'poll'. |
-
 <a name="module_RTKChat--module.exports+pin"></a>
 
 #### module.exports.pin(id)
@@ -321,29 +287,3 @@ Fetches pinned messages with pagination.
 | --- | --- | --- |
 | options | <code>FetchMessageOptions</code> | Configuration options for fetching pinned messages, including timestamp, limit, and direction. |
 
-<a name="module_RTKChat--module.exports+getMessages"></a>
-
-#### ~~module.exports.getMessages(timeStamp, size, reversed, [offset])~~
-***Deprecated***
-
-**Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKChat--module.exports)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| timeStamp | <code>number</code> |  | 
-| size | <code>number</code> |  | 
-| reversed | <code>boolean</code> |  | 
-| [offset] | <code>number</code> | <code>0</code> | 
-
-<a name="module_RTKChat--module.exports+searchMessages"></a>
-
-#### ~~module.exports.searchMessages(query, [filters])~~
-***Deprecated***
-
-**Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKChat--module.exports)  
-
-| Param | Type |
-| --- | --- |
-| query | <code>string</code> | 
-| [filters] | <code>SearchFilters</code> | 
-
@@ -1,7 +1,6 @@
 ---
 title: RTKConnectedMeetings
 sidebar_position: 4
-web_core_version: 1.2.4
 ---
 
 <!-- Auto Generated Below -->
@@ -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 | <code>Context</code> | 
 
-<a name="module_RTKConnectedMeetings--module.exports+getRTKConnectedMeetings"></a>
+<a name="module_RTKConnectedMeetings--module.exports+getConnectedMeetings"></a>
 
-#### module.exports.getRTKConnectedMeetings()
+#### module.exports.getConnectedMeetings()
 get connected meeting state
 
 **Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKConnectedMeetings--module.exports)  

@@ -1,7 +1,6 @@
 ---
 title: RTKLivestream
 sidebar_position: 5
-web_core_version: 1.2.4
 ---
 
 <!-- Auto Generated Below -->
@@ -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 [<code>module.exports</code>](#exp_module_RTKLivestream--module.exports)  
-<a name="module_RTKLivestream--module.exports+setRTKLivestreamState"></a>
+<a name="module_RTKLivestream--module.exports+setLivestreamState"></a>
 
-#### module.exports.setRTKLivestreamState(livestreamState)
+#### module.exports.setLivestreamState(livestreamState)
 **Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKLivestream--module.exports)  
 
 | Param | Type |
@@ -55,7 +54,7 @@ Starts livestreaming the meeting.
 
 | Param | Type |
 | --- | --- |
-| [livestreamConfig] | <code>StartRTKLivestreamConfig</code> | 
+| [livestreamConfig] | <code>StartLivestreamConfig</code> | 
 
 <a name="module_RTKLivestream--module.exports+stop"></a>
 

@@ -1,7 +1,6 @@
 ---
 title: RTKMeta
 sidebar_position: 6
-web_core_version: 1.2.4
 ---
 
 <!-- Auto Generated Below -->

@@ -1,7 +1,6 @@
 ---
 title: RTKParticipant
 sidebar_position: 7
-web_core_version: 1.2.4
 ---
 
 <!-- Auto Generated Below -->
@@ -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 | <code>Context</code> | 
-| participant | <code>IRTKParticipant</code> | 
+| participant | <code>IParticipant</code> | 
 | self | <code>Self</code> | 
 | roomSocket | <code>RoomSocketHandler</code> | 
 
@@ -95,17 +94,11 @@ The name of the participant.
 The picture of the participant.
 
 **Kind**: instance property of [<code>module.exports</code>](#exp_module_RTKParticipant--module.exports)  
-<a name="module_RTKParticipant--module.exports+customRTKParticipantId"></a>
+<a name="module_RTKParticipant--module.exports+customParticipantId"></a>
 
-#### module.exports.customRTKParticipantId
+#### module.exports.customParticipantId
 The custom id of the participant set during Add RTKParticipant REST API
 
-**Kind**: instance property of [<code>module.exports</code>](#exp_module_RTKParticipant--module.exports)  
-<a name="module_RTKParticipant--module.exports+clientSpecificId"></a>
-
-#### ~~module.exports.clientSpecificId~~
-***Deprecated***
-
 **Kind**: instance property of [<code>module.exports</code>](#exp_module_RTKParticipant--module.exports)  
 <a name="module_RTKParticipant--module.exports+device"></a>
 

@@ -1,7 +1,6 @@
 ---
 title: RTKParticipantMap
 sidebar_position: 20
-web_core_version: 1.2.4
 ---
 
 <!-- Auto Generated Below -->

@@ -1,7 +1,6 @@
 ---
 title: RTKParticipants
 sidebar_position: 8
-web_core_version: 1.2.4
 ---
 
 <!-- Auto Generated Below -->
@@ -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)
 
 <a name="exp_module_RTKParticipants--module.exports"></a>
 
@@ -85,8 +81,8 @@ Returns a list of all participants in the meeting.
 **Kind**: instance property of [<code>module.exports</code>](#exp_module_RTKParticipants--module.exports)  
 <a name="module_RTKParticipants--module.exports+active"></a>
 
-#### ~~module.exports.active~~
-***Deprecated***
+#### module.exports.active
+Returns a list of participants whose streams are currently consumed.
 
 **Kind**: instance property of [<code>module.exports</code>](#exp_module_RTKParticipants--module.exports)  
 <a name="module_RTKParticipants--module.exports+videoSubscribed"></a>
@@ -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 [<code>module.exports</code>](#exp_module_RTKParticipants--module.exports)  
-<a name="module_RTKParticipants--module.exports+maxActiveRTKParticipantsCount"></a>
+<a name="module_RTKParticipants--module.exports+maxActiveParticipantsCount"></a>
 
-#### 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 [<code>module.exports</code>](#exp_module_RTKParticipants--module.exports)  
-<a name="module_RTKParticipants--module.exports+setMaxActiveRTKParticipantsCount"></a>
+<a name="module_RTKParticipants--module.exports+setMaxActiveParticipantsCount"></a>
 
-#### 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 [<code>module.exports</code>](#exp_module_RTKParticipants--module.exports)  
-<a name="module_RTKParticipants--module.exports+disableAudio"></a>
-
-#### ~~module.exports.disableAudio(participantId)~~
-***Deprecated***
-
-**Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKParticipants--module.exports)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| participantId | <code>string</code> | ID of participant to be muted. |
-
-<a name="module_RTKParticipants--module.exports+disableVideo"></a>
-
-#### ~~module.exports.disableVideo(participantId)~~
-***Deprecated***
-
-**Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKParticipants--module.exports)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| participantId | <code>string</code> | ID of participant to be muted. |
-
-<a name="module_RTKParticipants--module.exports+kick"></a>
-
-#### ~~module.exports.kick(participantId)~~
-***Deprecated***
-
-**Kind**: instance method of [<code>module.exports</code>](#exp_module_RTKParticipants--module.exports)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| participantId | <code>string</code> | ID of participant to be kicked. |
-
 <a name="module_RTKParticipants--module.exports+kickAll"></a>
 
 #### module.exports.kickAll()
@@ -356,9 +319,9 @@ instead
 | limit | <code>number</code> | 
 | offset | <code>number</code> | 
 
-<a name="module_RTKParticipants--module.exports+getRTKParticipantsInMeetingPreJoin"></a>
+<a name="module_RTKParticipants--module.exports+getParticipantsInMeetingPreJoin"></a>
 
-#### 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`