From a651305636557e268c3af068ad948aa27107779f Mon Sep 17 00:00:00 2001 From: Rohan Mukherjee Date: Thu, 9 Jun 2022 21:02:06 +0530 Subject: [PATCH 1/9] fix: update reference for react-native-core and react-web-core (#31) --- bin/update-docs | 5 + docs/react-native-core/Reference/DyteChat.md | 4 +- .../react-native-core/Reference/DyteClient.md | 10 +- docs/react-native-core/Reference/DyteMeta.md | 4 +- .../Reference/DyteParticipant.md | 41 ++-- .../Reference/DyteParticipantMap.md | 3 +- .../Reference/DyteParticipants.md | 44 +++- .../Reference/DytePermissionsPreset.md | 221 ++++++++++++++++++ .../react-native-core/Reference/DytePlugin.md | 36 ++- .../Reference/DytePluginMap.md | 5 +- .../Reference/DytePlugins.md | 4 +- docs/react-native-core/Reference/DytePolls.md | 4 +- .../Reference/DyteRecording.md | 46 ++++ .../react-native-core/Reference/DyteRemote.md | 47 ++++ docs/react-native-core/Reference/DyteSelf.md | 71 +++++- .../Reference/DyteThemePreset.md | 86 +++++++ docs/react-web-core/Reference/DyteChat.md | 4 +- docs/react-web-core/Reference/DyteClient.md | 10 +- docs/react-web-core/Reference/DyteMeta.md | 4 +- .../Reference/DyteParticipant.md | 41 ++-- .../Reference/DyteParticipantMap.md | 3 +- .../Reference/DyteParticipants.md | 44 +++- .../Reference/DytePermissionsPreset.md | 221 ++++++++++++++++++ docs/react-web-core/Reference/DytePlugin.md | 36 ++- .../react-web-core/Reference/DytePluginMap.md | 5 +- docs/react-web-core/Reference/DytePlugins.md | 4 +- docs/react-web-core/Reference/DytePolls.md | 4 +- .../react-web-core/Reference/DyteRecording.md | 46 ++++ docs/react-web-core/Reference/DyteRemote.md | 47 ++++ docs/react-web-core/Reference/DyteSelf.md | 71 +++++- .../Reference/DyteThemePreset.md | 86 +++++++ 31 files changed, 1181 insertions(+), 76 deletions(-) create mode 100755 bin/update-docs create mode 100644 docs/react-native-core/Reference/DytePermissionsPreset.md create mode 100644 docs/react-native-core/Reference/DyteRecording.md create mode 100644 docs/react-native-core/Reference/DyteRemote.md create mode 100644 docs/react-native-core/Reference/DyteThemePreset.md create mode 100644 docs/react-web-core/Reference/DytePermissionsPreset.md create mode 100644 docs/react-web-core/Reference/DyteRecording.md create mode 100644 docs/react-web-core/Reference/DyteRemote.md create mode 100644 docs/react-web-core/Reference/DyteThemePreset.md diff --git a/bin/update-docs b/bin/update-docs new file mode 100755 index 0000000000..97eead0305 --- /dev/null +++ b/bin/update-docs @@ -0,0 +1,5 @@ +#!/bin/bash + +GH_TOKEN=$NPM_TOKEN ./bin/auto_update_docs.py -r web-core -d docs/web-core +GH_TOKEN=$NPM_TOKEN ./bin/auto_update_docs.py -r web-core -d docs/react-web-core +GH_TOKEN=$NPM_TOKEN ./bin/auto_update_docs.py -r web-core -d docs/react-native-core diff --git a/docs/react-native-core/Reference/DyteChat.md b/docs/react-native-core/Reference/DyteChat.md index fe4275384f..3f8c348cd0 100644 --- a/docs/react-native-core/Reference/DyteChat.md +++ b/docs/react-native-core/Reference/DyteChat.md @@ -1,6 +1,6 @@ --- -sidebar_position: 7 -web_core_version: 0.18.0 +sidebar_position: 8 +web_core_version: 0.24.0 --- diff --git a/docs/react-native-core/Reference/DyteClient.md b/docs/react-native-core/Reference/DyteClient.md index 3aba1053a1..4eb06dcf2b 100644 --- a/docs/react-native-core/Reference/DyteClient.md +++ b/docs/react-native-core/Reference/DyteClient.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -21,6 +21,7 @@ named `meeting`. * [.plugins](#module_DyteClient+plugins) * [.chat](#module_DyteClient+chat) * [.polls](#module_DyteClient+polls) + * [.remote](#module_DyteClient+remote) * [.joinRoom()](#module_DyteClient+joinRoom) * [.leaveRoom()](#module_DyteClient+leaveRoom) * _static_ @@ -69,6 +70,13 @@ This includes text messages, images, and files. The polls object stores the polls that were initiated in the meeting. It exposes methods to create and vote on polls. +**Kind**: instance property of [DyteClient](#module_DyteClient) + + +### meeting.remote +The remote object stores the remote control requests for the meeting. +It exposes methods to request, accept and end the remote control. + **Kind**: instance property of [DyteClient](#module_DyteClient) diff --git a/docs/react-native-core/Reference/DyteMeta.md b/docs/react-native-core/Reference/DyteMeta.md index 51b7a2b337..d9ded826a7 100644 --- a/docs/react-native-core/Reference/DyteMeta.md +++ b/docs/react-native-core/Reference/DyteMeta.md @@ -1,6 +1,6 @@ --- -sidebar_position: 6 -web_core_version: 0.18.0 +sidebar_position: 7 +web_core_version: 0.24.0 --- diff --git a/docs/react-native-core/Reference/DyteParticipant.md b/docs/react-native-core/Reference/DyteParticipant.md index 65b9d1eb97..572122e555 100644 --- a/docs/react-native-core/Reference/DyteParticipant.md +++ b/docs/react-native-core/Reference/DyteParticipant.md @@ -1,6 +1,6 @@ --- sidebar_position: 5 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -8,6 +8,14 @@ web_core_version: 0.18.0 This module represents a single participant in the meeting. +The participant object can be accessed from one of the participant lists +present in the `meeting.participants` object. For example, +```ts +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'); +``` * [DyteParticipant](#module_DyteParticipant) @@ -23,77 +31,84 @@ This module represents a single participant in the meeting. * [.videoEnabled](#module_DyteParticipant+videoEnabled) * [.audioEnabled](#module_DyteParticipant+audioEnabled) * [.screenShareEnabled](#module_DyteParticipant+screenShareEnabled) + * [.supportsRemoteControl](#module_DyteParticipant+supportsRemoteControl) -### meeting.participants.joined.get(participantId).id +### participant.id The peer ID of the participant. The participants are indexed by this ID in the participant map. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).userId +### participant.userId The user ID of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).name +### participant.name The name of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).picture +### participant.picture The picture of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).clientSpecificId +### participant.clientSpecificId The clientSpecificId of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).device +### participant.device The device configuration of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).videoTrack +### participant.videoTrack The participant's video track. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).audioTrack +### participant.audioTrack The participant's audio track. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).screenShareTracks +### participant.screenShareTracks The participant's screenshare video and audio track. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).videoEnabled +### participant.videoEnabled This is true if the participant's video is enabled. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).audioEnabled +### participant.audioEnabled This is true if the participant's audio is enabled. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).screenShareEnabled +### participant.screenShareEnabled This is true if the participant is screensharing. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) + + +### participant.supportsRemoteControl +This is true if the dyte participant supports remote control. + +**Kind**: instance property of [DyteParticipant](#module_DyteParticipant) diff --git a/docs/react-native-core/Reference/DyteParticipantMap.md b/docs/react-native-core/Reference/DyteParticipantMap.md index d3206ccc51..6e0cb6c23c 100644 --- a/docs/react-native-core/Reference/DyteParticipantMap.md +++ b/docs/react-native-core/Reference/DyteParticipantMap.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -13,4 +13,3 @@ For example, when a participant is added to this map, a `participantJoined` even emitted from the map. When a participant object emits an event `videoUpdate`, the map re-emits that event (provided the participant is present in the map). - diff --git a/docs/react-native-core/Reference/DyteParticipants.md b/docs/react-native-core/Reference/DyteParticipants.md index bb4cba14f8..927fde2fc1 100644 --- a/docs/react-native-core/Reference/DyteParticipants.md +++ b/docs/react-native-core/Reference/DyteParticipants.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -25,8 +25,12 @@ This module represents all the participants in the meeting. It consists of 4 map * [.count](#module_DyteParticipants+count) * [.maxActiveParticipantsCount](#module_DyteParticipants+maxActiveParticipantsCount) * [.pageCount](#module_DyteParticipants+pageCount) + * [.acceptWaitingRoomRequest(id)](#module_DyteParticipants+acceptWaitingRoomRequest) + * [.rejectWaitingRoomRequest(id)](#module_DyteParticipants+rejectWaitingRoomRequest) * [.setViewMode(viewMode)](#module_DyteParticipants+setViewMode) * [.setPage(page)](#module_DyteParticipants+setPage) + * [.pin()](#module_DyteParticipants+pin) + * [.unpin()](#module_DyteParticipants+unpin) * [.disableAllAudio(allowUnMute)](#module_DyteParticipants+disableAllAudio) * [.disableAllVideo()](#module_DyteParticipants+disableAllVideo) * [.disableAudio(peerId)](#module_DyteParticipants+disableAudio) @@ -105,6 +109,30 @@ 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 [DyteParticipants](#module_DyteParticipants) + + +### meeting.participants.acceptWaitingRoomRequest(id) +Accepts requests from waitlisted participants if user +has appropriate permissions. + +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) + +| Param | Description | +| --- | --- | +| id | participantId of the waitlisted participant. | + + + +### meeting.participants.rejectWaitingRoomRequest(id) +Rejects requests from waitlisted participants if user +has appropriate permissions. + +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) + +| Param | Description | +| --- | --- | +| id | participantId of the waitlisted participant. | + ### meeting.participants.setViewMode(viewMode) @@ -129,6 +157,20 @@ Does not do anything in ACTIVE_GRID mode. | --- | --- | | page | The page number to be set. | + + +### meeting.participants.pin() +Returns `participant.id` if user has permission +to pin participants. + +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) + + +### meeting.participants.unpin() +Returns `participant.id` if user has permission +to unpin participants. + +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) ### meeting.participants.disableAllAudio(allowUnMute) diff --git a/docs/react-native-core/Reference/DytePermissionsPreset.md b/docs/react-native-core/Reference/DytePermissionsPreset.md new file mode 100644 index 0000000000..a94bc787ad --- /dev/null +++ b/docs/react-native-core/Reference/DytePermissionsPreset.md @@ -0,0 +1,221 @@ +--- +sidebar_position: 6 +web_core_version: 0.24.0 +--- + + + + + +The DytePermissionsPreset class represents the meeting permissions for the current participant + + +* [DytePermissionsPreset](#module_DytePermissionsPreset) + * [.viewType](#module_DytePermissionsPreset+viewType) + * [.acceptWaitingRequests](#module_DytePermissionsPreset+acceptWaitingRequests) + * [.requestProduce](#module_DytePermissionsPreset+requestProduce) + * [.canAllowParticipantAudio](#module_DytePermissionsPreset+canAllowParticipantAudio) + * [.canAllowParticipantScreensharing](#module_DytePermissionsPreset+canAllowParticipantScreensharing) + * [.canAllowParticipantVideo](#module_DytePermissionsPreset+canAllowParticipantVideo) + * [.requestKickParticipant](#module_DytePermissionsPreset+requestKickParticipant) + * [.kickParticipant](#module_DytePermissionsPreset+kickParticipant) + * [.pinParticipant](#module_DytePermissionsPreset+pinParticipant) + * [.canRecord](#module_DytePermissionsPreset+canRecord) + * [.waitingRoomType](#module_DytePermissionsPreset+waitingRoomType) + * [.plugins](#module_DytePermissionsPreset+plugins) + * [.polls](#module_DytePermissionsPreset+polls) + * [.produceVideo](#module_DytePermissionsPreset+produceVideo) + * [.produceScreenshare](#module_DytePermissionsPreset+produceScreenshare) + * [.produceAudio](#module_DytePermissionsPreset+produceAudio) + * [.chatPublic](#module_DytePermissionsPreset+chatPublic) + * [.chatPrivate](#module_DytePermissionsPreset+chatPrivate) + * [.reactions](#module_DytePermissionsPreset+reactions) + * [.hiddenParticipant](#module_DytePermissionsPreset+hiddenParticipant) + * [.showParticipantList](#module_DytePermissionsPreset+showParticipantList) + * [.canChangeParticipantRole](#module_DytePermissionsPreset+canChangeParticipantRole) + * [.canChangeTheme](#module_DytePermissionsPreset+canChangeTheme) + * [.canPresent](#module_DytePermissionsPreset+canPresent) + + + +### meeting.self.permissions.viewType +The `viewType` tells the type of the meeting +possible values are WEBINAR, GROUPCALL + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.acceptWaitingRequests +The `acceptWaitingRequests` returns boolean value. +If `true`, participant can accept the request of waiting participant. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.requestProduce +The `requestProduce` returns boolean value. +If `true`, participant can send request to participants +about producing audio, video or screenshare. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canAllowParticipantAudio +The `canAllowParticipantAudio` returns boolean value. +If `true`, participant can enable other participants` audio. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canAllowParticipantScreensharing +The `canAllowParticipantScreensharing` returns boolean value. +If `true`, participant can enable other participants` screen share. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canAllowParticipantVideo +The `canAllowParticipantVideo` returns boolean value. +If `true`, participant can enable other participants` video. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.requestKickParticipant +The `requestKickParticipant` returns boolean value. +If `true`, participant can request to remove another participant from the meeting. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.kickParticipant +The `kickParticipant` returns boolean value. +If `true`, participant can remove other participants from the meeting. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.pinParticipant +The `pinParticipant` returns boolean value. +If `true`, participant can pin a participant in the meeting. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canRecord +The `canRecord` returns boolean value. +If `true`, participant can record the meeting. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.waitingRoomType +The `waitingRoomType` returns string value. +type of waiting room behavior +possible values are `SKIP_ON_ACCEPT`, `ON_ACCEPT`, `SKIP_ON_PRIVILEGED_USER_ENTRY` + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.plugins +The `plugins` tells if the participant can act on plugins +there are 2 permissions with boolean values, `canStart` and `canClose`. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.polls +The `polls` tells if the participant can use polls. +There are 3 permissions with boolean values, `canCreate`, `canVote`, `canView` + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.produceVideo +The `produceVideo` shows permissions for enabling video for the participant. +There are 3 permissions +`allow` - if video is allowed +`quality` - quality of the video +`frameRate` - frame rate of the video + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.produceScreenshare +The `produceScreenshare` shows permissions for enabling screen share for the participant. +There are 3 permissions +`allow` - if sharing screen is allowed +`quality` - quality of the video +`frameRate` - frame rate of the video + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.produceAudio +The `produceAudio` shows permissions for enabling audio for the participant. +If true, participant can enable audio. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.chatPublic +The `chatPublic` shows permissions for public chat +there are 4 permissions +`canSend` - if true, the participant can send chat +`text` - if true, the participant can send text +`files` - if true, the participant can send files + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.chatPrivate +The `chatPrivate` shows permissions for public chat +there are 4 permissions +`canSend` - if true, the participant can send private chat +`text` - if true, the participant can send text as private chat +`files` - if true, the participant can send files as private chat +`canReceive` - (optional) if true, the participant can receive private chat + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.reactions +The `reactions` returns boolean value. +If `true`, reactions are enabled for the participant + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.hiddenParticipant +The `hiddenParticipant` returns boolean value. +If `true`, participant is hidden. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.showParticipantList +The `showParticipantList` returns boolean value. +If `true`, participant list can be shown to the participant. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canChangeParticipantRole +The `canChangeParticipantRole` returns boolean value. +If `true`, allow changing the participants' role. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canChangeTheme +The `canChangeTheme` returns boolean value. +If `true`, the participant can change the meeting theme. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canPresent +The `canPresent` returns boolean value. +If `true`, the participant can become a presentor. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) diff --git a/docs/react-native-core/Reference/DytePlugin.md b/docs/react-native-core/Reference/DytePlugin.md index 8e7daf0d2a..9513a1afa7 100644 --- a/docs/react-native-core/Reference/DytePlugin.md +++ b/docs/react-native-core/Reference/DytePlugin.md @@ -1,6 +1,6 @@ --- -sidebar_position: 11 -web_core_version: 0.18.0 +sidebar_position: 12 +web_core_version: 0.24.0 --- @@ -8,10 +8,17 @@ web_core_version: 0.18.0 The DytePlugin module represents a single plugin in the meeting. +A plugin can be obtained from one of the plugin arrays in `meeting.plugins`. +For example, +```ts +const plugin1 = meeting.plugins.active.get(pluginId); +const plugin2 = meeting.plugins.all.get(pluginId); +``` * [DytePlugin](#module_DytePlugin) * [.sendIframeEvent(message)](#module_DytePlugin+sendIframeEvent) + * [.sendData(data)](#module_DytePlugin+sendData) * [.removePluginView(viewId)](#module_DytePlugin+removePluginView) * [.addPluginView(iframe, viewId)](#module_DytePlugin+addPluginView) * [.enable()](#module_DytePlugin+enable) @@ -21,16 +28,27 @@ The DytePlugin module represents a single plugin in the meeting. -### meeting.plugins.all.get(pluginId).sendIframeEvent(message) +### plugin.sendIframeEvent(message) **Kind**: instance method of [DytePlugin](#module_DytePlugin) | Param | Description | | --- | --- | | message | Socket message forwarded to this plugin. | + + +### plugin.sendData(data) +This method is used to send arbitrary data to the plugin. + +**Kind**: instance method of [DytePlugin](#module_DytePlugin) + +| Param | Description | +| --- | --- | +| data | The data that you want to send inside the plugin. | + -### meeting.plugins.all.get(pluginId).removePluginView(viewId) +### plugin.removePluginView(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. @@ -42,7 +60,7 @@ be used before the iframe is removed from the DOM. -### meeting.plugins.all.get(pluginId).addPluginView(iframe, viewId) +### plugin.addPluginView(iframe, viewId) This method adds the communcation layer between the plugin inside the iframe and the core application (meeting object) in the main window. @@ -55,25 +73,25 @@ and the core application (meeting object) in the main window. -### meeting.plugins.all.get(pluginId).enable() +### plugin.enable() Enable this plugin for the current user. **Kind**: instance method of [DytePlugin](#module_DytePlugin) -### meeting.plugins.all.get(pluginId).disable() +### plugin.disable() Disable this plugin for the current user. **Kind**: instance method of [DytePlugin](#module_DytePlugin) -### meeting.plugins.all.get(pluginId).activate() +### plugin.activate() Activate this plugin for all participants. **Kind**: instance method of [DytePlugin](#module_DytePlugin) -### meeting.plugins.all.get(pluginId).deactivate() +### plugin.deactivate() Deactivate this plugin for all participants. **Kind**: instance method of [DytePlugin](#module_DytePlugin) diff --git a/docs/react-native-core/Reference/DytePluginMap.md b/docs/react-native-core/Reference/DytePluginMap.md index d17235e716..9e30899cb4 100644 --- a/docs/react-native-core/Reference/DytePluginMap.md +++ b/docs/react-native-core/Reference/DytePluginMap.md @@ -1,6 +1,6 @@ --- -sidebar_position: 10 -web_core_version: 0.18.0 +sidebar_position: 11 +web_core_version: 0.24.0 --- @@ -13,4 +13,3 @@ For example, when a plugin is added to this map, a `pluginAdded` event is emitted from the map. When a plugin object emits an event `stateUpdate`, the map re-emits that event (provided the plugin is present in the map). - diff --git a/docs/react-native-core/Reference/DytePlugins.md b/docs/react-native-core/Reference/DytePlugins.md index 72372a72ef..7c17d44585 100644 --- a/docs/react-native-core/Reference/DytePlugins.md +++ b/docs/react-native-core/Reference/DytePlugins.md @@ -1,6 +1,6 @@ --- -sidebar_position: 9 -web_core_version: 0.18.0 +sidebar_position: 10 +web_core_version: 0.24.0 --- diff --git a/docs/react-native-core/Reference/DytePolls.md b/docs/react-native-core/Reference/DytePolls.md index 70e2507da8..f4d76cdc63 100644 --- a/docs/react-native-core/Reference/DytePolls.md +++ b/docs/react-native-core/Reference/DytePolls.md @@ -1,6 +1,6 @@ --- -sidebar_position: 8 -web_core_version: 0.18.0 +sidebar_position: 9 +web_core_version: 0.24.0 --- diff --git a/docs/react-native-core/Reference/DyteRecording.md b/docs/react-native-core/Reference/DyteRecording.md new file mode 100644 index 0000000000..52c2450c12 --- /dev/null +++ b/docs/react-native-core/Reference/DyteRecording.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 15 +web_core_version: 0.24.0 +--- + + + + + +The DyteRecording module represents the state of the current recording, and allows +to start/stop recordings and check if there's a recording in progress. + + +* [DyteRecording](#module_DyteRecording) + * [.recordingId](#module_DyteRecording+recordingId) + * [.start()](#module_DyteRecording+start) + * [.stop()](#module_DyteRecording+stop) + * [.refreshActiveRecordingState()](#module_DyteRecording+refreshActiveRecordingState) + + + +### meeting.recording.recordingId +NOTE(CallMeTarush): +Not setting recording state here, waiting for recording +peer to join to set state automatically + +**Kind**: instance property of [DyteRecording](#module_DyteRecording) + + +### meeting.recording.start() +Starts recording the meeting. + +**Kind**: instance method of [DyteRecording](#module_DyteRecording) + + +### meeting.recording.stop() +Stops recording the meeting assuming there +is a recording in progress. + +**Kind**: instance method of [DyteRecording](#module_DyteRecording) + + +### meeting.recording.refreshActiveRecordingState() +Refreshes current recording state. + +**Kind**: instance method of [DyteRecording](#module_DyteRecording) diff --git a/docs/react-native-core/Reference/DyteRemote.md b/docs/react-native-core/Reference/DyteRemote.md new file mode 100644 index 0000000000..1122007cba --- /dev/null +++ b/docs/react-native-core/Reference/DyteRemote.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 14 +web_core_version: 0.24.0 +--- + + + + + +This module provides the ability to control a remotely shared screen using mouse and keyboard. +Methods are available to request, accept and end control of shared screen. + + +* [DyteRemote](#module_DyteRemote) + * [.requestControl(peerId)](#module_DyteRemote+requestControl) ⇒ + * [.acceptControl(requestId)](#module_DyteRemote+acceptControl) + * [.endControl()](#module_DyteRemote+endControl) + + + +### meeting.remote.requestControl(peerId) ⇒ +Sends a request to a peer for remote control. + +**Kind**: instance method of [DyteRemote](#module_DyteRemote) +**Returns**: request identifier for the control request. + +| Param | Description | +| --- | --- | +| peerId | The peer that needs to receive the remote control request | + + + +### meeting.remote.acceptControl(requestId) +Accepts a remote control request from a peer. + +**Kind**: instance method of [DyteRemote](#module_DyteRemote) + +| Param | Description | +| --- | --- | +| requestId | The request identifier that needs to be accepted | + + + +### meeting.remote.endControl() +End an active remote control. + +**Kind**: instance method of [DyteRemote](#module_DyteRemote) diff --git a/docs/react-native-core/Reference/DyteSelf.md b/docs/react-native-core/Reference/DyteSelf.md index 65fc6e2e0a..435d9e99d4 100644 --- a/docs/react-native-core/Reference/DyteSelf.md +++ b/docs/react-native-core/Reference/DyteSelf.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -14,7 +14,9 @@ this module. * [DyteSelf](#module_DyteSelf) * [.audioTrack](#module_DyteSelf+audioTrack) + * [.rawAudioTrack](#module_DyteSelf+rawAudioTrack) * [.videoTrack](#module_DyteSelf+videoTrack) + * [.rawVideoTrack](#module_DyteSelf+rawVideoTrack) * [.screenShareTracks](#module_DyteSelf+screenShareTracks) * [.audioEnabled](#module_DyteSelf+audioEnabled) * [.videoEnabled](#module_DyteSelf+videoEnabled) @@ -23,6 +25,10 @@ this module. * [.permissions](#module_DyteSelf+permissions) * [.suggestedTheme](#module_DyteSelf+suggestedTheme) * [.roomJoined](#module_DyteSelf+roomJoined) + * [.addAudioMiddleware()](#module_DyteSelf+addAudioMiddleware) + * [.removeAudioMiddleware()](#module_DyteSelf+removeAudioMiddleware) + * [.addVideoMiddleware()](#module_DyteSelf+addVideoMiddleware) + * [.removeVideoMiddleware()](#module_DyteSelf+removeVideoMiddleware) * [.setName(name)](#module_DyteSelf+setName) * [.setupTracks(options)](#module_DyteSelf+setupTracks) * [.enableAudio()](#module_DyteSelf+enableAudio) @@ -39,6 +45,9 @@ this module. * [.getSpeakerDevices()](#module_DyteSelf+getSpeakerDevices) * [.getDeviceById(deviceId, kind)](#module_DyteSelf+getDeviceById) * [.getAllDevices()](#module_DyteSelf+getAllDevices) + * [.pinned()](#module_DyteSelf+pinned) + * [.pin()](#module_DyteSelf+pin) + * [.unpin()](#module_DyteSelf+unpin) * [.setDevice(device, preview)](#module_DyteSelf+setDevice) @@ -46,12 +55,24 @@ this module. ### meeting.self.audioTrack Returns the `audioTrack`. +**Kind**: instance property of [DyteSelf](#module_DyteSelf) + + +### meeting.self.rawAudioTrack +Returns the `rawAudioTrack` having no middleware executed on it. + **Kind**: instance property of [DyteSelf](#module_DyteSelf) ### meeting.self.videoTrack Returns the `videoTrack`. +**Kind**: instance property of [DyteSelf](#module_DyteSelf) + + +### meeting.self.rawVideoTrack +Returns the `videoTrack` having no middleware executed on it. + **Kind**: instance property of [DyteSelf](#module_DyteSelf) @@ -105,6 +126,36 @@ Returns suggested theme for the meeting. Returns true if the local participant has joined the meeting. **Kind**: instance property of [DyteSelf](#module_DyteSelf) + + +### meeting.self.addAudioMiddleware() +Adds the audio middleware to be executed on the raw audio stream. +If there are more than 1 audio middlewares, +they will be executed in the sequence they were added in. +If you want the sequence to be altered, please remove all previous middlewares and re-add. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.removeAudioMiddleware() +Removes the audio middleware, if it is there. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.addVideoMiddleware() +Adds the video middleware to be executed on the raw video stream. +If there are more than 1 video middlewares, +they will be executed in the sequence they were added in. +If you want the sequence to be altered, please remove all previous middlewares and re-add. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.removeVideoMiddleware() +Removes the video middleware, if it is there. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) ### meeting.self.setName(name) @@ -231,6 +282,24 @@ Returns the local participant's device, indexed by ID and kind. ### meeting.self.getAllDevices() Returns all media devices accessible by the local participant. +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.pinned() +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.pin() +Returns `self.id` if user has permission +to pin participants. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.unpin() +Returns `self.id` if user has permission +to unpin participants. + **Kind**: instance method of [DyteSelf](#module_DyteSelf) diff --git a/docs/react-native-core/Reference/DyteThemePreset.md b/docs/react-native-core/Reference/DyteThemePreset.md new file mode 100644 index 0000000000..a1d80c176e --- /dev/null +++ b/docs/react-native-core/Reference/DyteThemePreset.md @@ -0,0 +1,86 @@ +--- +sidebar_position: 13 +web_core_version: 0.24.0 +--- + + + + + +The DyteThemePreset class represents the meeting theme for the current participant + + +* [DyteThemePreset](#module_DyteThemePreset) + * [.setupScreen](#module_DyteThemePreset+setupScreen) + * [.aloneHere](#module_DyteThemePreset+aloneHere) + * [.waitingRoom](#module_DyteThemePreset+waitingRoom) + * [.controlBar](#module_DyteThemePreset+controlBar) + * [.header](#module_DyteThemePreset+header) + * [.pipMode](#module_DyteThemePreset+pipMode) + * [.autoTune](#module_DyteThemePreset+autoTune) + * [.grid](#module_DyteThemePreset+grid) + + + +### meeting.self.suggestedTheme.setupScreen +The `setupScreen` represents the setup screen for the meeting. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.aloneHere +The `aloneHere` contains the properties to show a layout when +the participant is alone in the meeting. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.waitingRoom +The `waitingRoom` contains the properties to show a layout when +the participant is in waiting to join the meeting. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.controlBar +The `controlBar` contains the properties to show the meeting control bar with +various action buttons for the meeting. +The `elements` key contains the various action buttons. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.header +The `header` contains the properties to show the meeting header with various elements. +The `elements` key contains the following properties +`logo` - string value representing the public URL for the logo +`timer` - boolean value suggesting if the timer should be shown +`title` - boolean value suggesting if the meeting title should be shown +`participantCount` - boolean value suggesting if the participant count shuld be shown +`changeLayout` - boolean value suggesting if the participant can change layout + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.pipMode +The `pipMode` property returns a boolean value +If true, picture-in-picture mode is enabled for the participant. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.autoTune +The `autoTune` property returns a boolean value +If true, force the participant's video to be in compatibility mode. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.grid +The `grid` contains the properties to show participant grid for the meeting. +`defaultView` key points to the view type, possible values are `MULTI`, `SINGLE` +`multi` and `single` keys contain the following preferences to show grid layout. +`maxVideoCount` - number of participants to show in the grid. +`videoFit` - string value suggesting how to align the video content. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) diff --git a/docs/react-web-core/Reference/DyteChat.md b/docs/react-web-core/Reference/DyteChat.md index fe4275384f..3f8c348cd0 100644 --- a/docs/react-web-core/Reference/DyteChat.md +++ b/docs/react-web-core/Reference/DyteChat.md @@ -1,6 +1,6 @@ --- -sidebar_position: 7 -web_core_version: 0.18.0 +sidebar_position: 8 +web_core_version: 0.24.0 --- diff --git a/docs/react-web-core/Reference/DyteClient.md b/docs/react-web-core/Reference/DyteClient.md index 3aba1053a1..4eb06dcf2b 100644 --- a/docs/react-web-core/Reference/DyteClient.md +++ b/docs/react-web-core/Reference/DyteClient.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -21,6 +21,7 @@ named `meeting`. * [.plugins](#module_DyteClient+plugins) * [.chat](#module_DyteClient+chat) * [.polls](#module_DyteClient+polls) + * [.remote](#module_DyteClient+remote) * [.joinRoom()](#module_DyteClient+joinRoom) * [.leaveRoom()](#module_DyteClient+leaveRoom) * _static_ @@ -69,6 +70,13 @@ This includes text messages, images, and files. The polls object stores the polls that were initiated in the meeting. It exposes methods to create and vote on polls. +**Kind**: instance property of [DyteClient](#module_DyteClient) + + +### meeting.remote +The remote object stores the remote control requests for the meeting. +It exposes methods to request, accept and end the remote control. + **Kind**: instance property of [DyteClient](#module_DyteClient) diff --git a/docs/react-web-core/Reference/DyteMeta.md b/docs/react-web-core/Reference/DyteMeta.md index 51b7a2b337..d9ded826a7 100644 --- a/docs/react-web-core/Reference/DyteMeta.md +++ b/docs/react-web-core/Reference/DyteMeta.md @@ -1,6 +1,6 @@ --- -sidebar_position: 6 -web_core_version: 0.18.0 +sidebar_position: 7 +web_core_version: 0.24.0 --- diff --git a/docs/react-web-core/Reference/DyteParticipant.md b/docs/react-web-core/Reference/DyteParticipant.md index 65b9d1eb97..572122e555 100644 --- a/docs/react-web-core/Reference/DyteParticipant.md +++ b/docs/react-web-core/Reference/DyteParticipant.md @@ -1,6 +1,6 @@ --- sidebar_position: 5 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -8,6 +8,14 @@ web_core_version: 0.18.0 This module represents a single participant in the meeting. +The participant object can be accessed from one of the participant lists +present in the `meeting.participants` object. For example, +```ts +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'); +``` * [DyteParticipant](#module_DyteParticipant) @@ -23,77 +31,84 @@ This module represents a single participant in the meeting. * [.videoEnabled](#module_DyteParticipant+videoEnabled) * [.audioEnabled](#module_DyteParticipant+audioEnabled) * [.screenShareEnabled](#module_DyteParticipant+screenShareEnabled) + * [.supportsRemoteControl](#module_DyteParticipant+supportsRemoteControl) -### meeting.participants.joined.get(participantId).id +### participant.id The peer ID of the participant. The participants are indexed by this ID in the participant map. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).userId +### participant.userId The user ID of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).name +### participant.name The name of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).picture +### participant.picture The picture of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).clientSpecificId +### participant.clientSpecificId The clientSpecificId of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).device +### participant.device The device configuration of the participant. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).videoTrack +### participant.videoTrack The participant's video track. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).audioTrack +### participant.audioTrack The participant's audio track. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).screenShareTracks +### participant.screenShareTracks The participant's screenshare video and audio track. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).videoEnabled +### participant.videoEnabled This is true if the participant's video is enabled. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).audioEnabled +### participant.audioEnabled This is true if the participant's audio is enabled. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) -### meeting.participants.joined.get(participantId).screenShareEnabled +### participant.screenShareEnabled This is true if the participant is screensharing. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) + + +### participant.supportsRemoteControl +This is true if the dyte participant supports remote control. + +**Kind**: instance property of [DyteParticipant](#module_DyteParticipant) diff --git a/docs/react-web-core/Reference/DyteParticipantMap.md b/docs/react-web-core/Reference/DyteParticipantMap.md index d3206ccc51..6e0cb6c23c 100644 --- a/docs/react-web-core/Reference/DyteParticipantMap.md +++ b/docs/react-web-core/Reference/DyteParticipantMap.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -13,4 +13,3 @@ For example, when a participant is added to this map, a `participantJoined` even emitted from the map. When a participant object emits an event `videoUpdate`, the map re-emits that event (provided the participant is present in the map). - diff --git a/docs/react-web-core/Reference/DyteParticipants.md b/docs/react-web-core/Reference/DyteParticipants.md index bb4cba14f8..927fde2fc1 100644 --- a/docs/react-web-core/Reference/DyteParticipants.md +++ b/docs/react-web-core/Reference/DyteParticipants.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -25,8 +25,12 @@ This module represents all the participants in the meeting. It consists of 4 map * [.count](#module_DyteParticipants+count) * [.maxActiveParticipantsCount](#module_DyteParticipants+maxActiveParticipantsCount) * [.pageCount](#module_DyteParticipants+pageCount) + * [.acceptWaitingRoomRequest(id)](#module_DyteParticipants+acceptWaitingRoomRequest) + * [.rejectWaitingRoomRequest(id)](#module_DyteParticipants+rejectWaitingRoomRequest) * [.setViewMode(viewMode)](#module_DyteParticipants+setViewMode) * [.setPage(page)](#module_DyteParticipants+setPage) + * [.pin()](#module_DyteParticipants+pin) + * [.unpin()](#module_DyteParticipants+unpin) * [.disableAllAudio(allowUnMute)](#module_DyteParticipants+disableAllAudio) * [.disableAllVideo()](#module_DyteParticipants+disableAllVideo) * [.disableAudio(peerId)](#module_DyteParticipants+disableAudio) @@ -105,6 +109,30 @@ 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 [DyteParticipants](#module_DyteParticipants) + + +### meeting.participants.acceptWaitingRoomRequest(id) +Accepts requests from waitlisted participants if user +has appropriate permissions. + +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) + +| Param | Description | +| --- | --- | +| id | participantId of the waitlisted participant. | + + + +### meeting.participants.rejectWaitingRoomRequest(id) +Rejects requests from waitlisted participants if user +has appropriate permissions. + +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) + +| Param | Description | +| --- | --- | +| id | participantId of the waitlisted participant. | + ### meeting.participants.setViewMode(viewMode) @@ -129,6 +157,20 @@ Does not do anything in ACTIVE_GRID mode. | --- | --- | | page | The page number to be set. | + + +### meeting.participants.pin() +Returns `participant.id` if user has permission +to pin participants. + +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) + + +### meeting.participants.unpin() +Returns `participant.id` if user has permission +to unpin participants. + +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) ### meeting.participants.disableAllAudio(allowUnMute) diff --git a/docs/react-web-core/Reference/DytePermissionsPreset.md b/docs/react-web-core/Reference/DytePermissionsPreset.md new file mode 100644 index 0000000000..a94bc787ad --- /dev/null +++ b/docs/react-web-core/Reference/DytePermissionsPreset.md @@ -0,0 +1,221 @@ +--- +sidebar_position: 6 +web_core_version: 0.24.0 +--- + + + + + +The DytePermissionsPreset class represents the meeting permissions for the current participant + + +* [DytePermissionsPreset](#module_DytePermissionsPreset) + * [.viewType](#module_DytePermissionsPreset+viewType) + * [.acceptWaitingRequests](#module_DytePermissionsPreset+acceptWaitingRequests) + * [.requestProduce](#module_DytePermissionsPreset+requestProduce) + * [.canAllowParticipantAudio](#module_DytePermissionsPreset+canAllowParticipantAudio) + * [.canAllowParticipantScreensharing](#module_DytePermissionsPreset+canAllowParticipantScreensharing) + * [.canAllowParticipantVideo](#module_DytePermissionsPreset+canAllowParticipantVideo) + * [.requestKickParticipant](#module_DytePermissionsPreset+requestKickParticipant) + * [.kickParticipant](#module_DytePermissionsPreset+kickParticipant) + * [.pinParticipant](#module_DytePermissionsPreset+pinParticipant) + * [.canRecord](#module_DytePermissionsPreset+canRecord) + * [.waitingRoomType](#module_DytePermissionsPreset+waitingRoomType) + * [.plugins](#module_DytePermissionsPreset+plugins) + * [.polls](#module_DytePermissionsPreset+polls) + * [.produceVideo](#module_DytePermissionsPreset+produceVideo) + * [.produceScreenshare](#module_DytePermissionsPreset+produceScreenshare) + * [.produceAudio](#module_DytePermissionsPreset+produceAudio) + * [.chatPublic](#module_DytePermissionsPreset+chatPublic) + * [.chatPrivate](#module_DytePermissionsPreset+chatPrivate) + * [.reactions](#module_DytePermissionsPreset+reactions) + * [.hiddenParticipant](#module_DytePermissionsPreset+hiddenParticipant) + * [.showParticipantList](#module_DytePermissionsPreset+showParticipantList) + * [.canChangeParticipantRole](#module_DytePermissionsPreset+canChangeParticipantRole) + * [.canChangeTheme](#module_DytePermissionsPreset+canChangeTheme) + * [.canPresent](#module_DytePermissionsPreset+canPresent) + + + +### meeting.self.permissions.viewType +The `viewType` tells the type of the meeting +possible values are WEBINAR, GROUPCALL + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.acceptWaitingRequests +The `acceptWaitingRequests` returns boolean value. +If `true`, participant can accept the request of waiting participant. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.requestProduce +The `requestProduce` returns boolean value. +If `true`, participant can send request to participants +about producing audio, video or screenshare. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canAllowParticipantAudio +The `canAllowParticipantAudio` returns boolean value. +If `true`, participant can enable other participants` audio. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canAllowParticipantScreensharing +The `canAllowParticipantScreensharing` returns boolean value. +If `true`, participant can enable other participants` screen share. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canAllowParticipantVideo +The `canAllowParticipantVideo` returns boolean value. +If `true`, participant can enable other participants` video. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.requestKickParticipant +The `requestKickParticipant` returns boolean value. +If `true`, participant can request to remove another participant from the meeting. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.kickParticipant +The `kickParticipant` returns boolean value. +If `true`, participant can remove other participants from the meeting. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.pinParticipant +The `pinParticipant` returns boolean value. +If `true`, participant can pin a participant in the meeting. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canRecord +The `canRecord` returns boolean value. +If `true`, participant can record the meeting. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.waitingRoomType +The `waitingRoomType` returns string value. +type of waiting room behavior +possible values are `SKIP_ON_ACCEPT`, `ON_ACCEPT`, `SKIP_ON_PRIVILEGED_USER_ENTRY` + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.plugins +The `plugins` tells if the participant can act on plugins +there are 2 permissions with boolean values, `canStart` and `canClose`. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.polls +The `polls` tells if the participant can use polls. +There are 3 permissions with boolean values, `canCreate`, `canVote`, `canView` + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.produceVideo +The `produceVideo` shows permissions for enabling video for the participant. +There are 3 permissions +`allow` - if video is allowed +`quality` - quality of the video +`frameRate` - frame rate of the video + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.produceScreenshare +The `produceScreenshare` shows permissions for enabling screen share for the participant. +There are 3 permissions +`allow` - if sharing screen is allowed +`quality` - quality of the video +`frameRate` - frame rate of the video + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.produceAudio +The `produceAudio` shows permissions for enabling audio for the participant. +If true, participant can enable audio. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.chatPublic +The `chatPublic` shows permissions for public chat +there are 4 permissions +`canSend` - if true, the participant can send chat +`text` - if true, the participant can send text +`files` - if true, the participant can send files + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.chatPrivate +The `chatPrivate` shows permissions for public chat +there are 4 permissions +`canSend` - if true, the participant can send private chat +`text` - if true, the participant can send text as private chat +`files` - if true, the participant can send files as private chat +`canReceive` - (optional) if true, the participant can receive private chat + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.reactions +The `reactions` returns boolean value. +If `true`, reactions are enabled for the participant + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.hiddenParticipant +The `hiddenParticipant` returns boolean value. +If `true`, participant is hidden. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.showParticipantList +The `showParticipantList` returns boolean value. +If `true`, participant list can be shown to the participant. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canChangeParticipantRole +The `canChangeParticipantRole` returns boolean value. +If `true`, allow changing the participants' role. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canChangeTheme +The `canChangeTheme` returns boolean value. +If `true`, the participant can change the meeting theme. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) + + +### meeting.self.permissions.canPresent +The `canPresent` returns boolean value. +If `true`, the participant can become a presentor. + +**Kind**: instance property of [DytePermissionsPreset](#module_DytePermissionsPreset) diff --git a/docs/react-web-core/Reference/DytePlugin.md b/docs/react-web-core/Reference/DytePlugin.md index 8e7daf0d2a..9513a1afa7 100644 --- a/docs/react-web-core/Reference/DytePlugin.md +++ b/docs/react-web-core/Reference/DytePlugin.md @@ -1,6 +1,6 @@ --- -sidebar_position: 11 -web_core_version: 0.18.0 +sidebar_position: 12 +web_core_version: 0.24.0 --- @@ -8,10 +8,17 @@ web_core_version: 0.18.0 The DytePlugin module represents a single plugin in the meeting. +A plugin can be obtained from one of the plugin arrays in `meeting.plugins`. +For example, +```ts +const plugin1 = meeting.plugins.active.get(pluginId); +const plugin2 = meeting.plugins.all.get(pluginId); +``` * [DytePlugin](#module_DytePlugin) * [.sendIframeEvent(message)](#module_DytePlugin+sendIframeEvent) + * [.sendData(data)](#module_DytePlugin+sendData) * [.removePluginView(viewId)](#module_DytePlugin+removePluginView) * [.addPluginView(iframe, viewId)](#module_DytePlugin+addPluginView) * [.enable()](#module_DytePlugin+enable) @@ -21,16 +28,27 @@ The DytePlugin module represents a single plugin in the meeting. -### meeting.plugins.all.get(pluginId).sendIframeEvent(message) +### plugin.sendIframeEvent(message) **Kind**: instance method of [DytePlugin](#module_DytePlugin) | Param | Description | | --- | --- | | message | Socket message forwarded to this plugin. | + + +### plugin.sendData(data) +This method is used to send arbitrary data to the plugin. + +**Kind**: instance method of [DytePlugin](#module_DytePlugin) + +| Param | Description | +| --- | --- | +| data | The data that you want to send inside the plugin. | + -### meeting.plugins.all.get(pluginId).removePluginView(viewId) +### plugin.removePluginView(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. @@ -42,7 +60,7 @@ be used before the iframe is removed from the DOM. -### meeting.plugins.all.get(pluginId).addPluginView(iframe, viewId) +### plugin.addPluginView(iframe, viewId) This method adds the communcation layer between the plugin inside the iframe and the core application (meeting object) in the main window. @@ -55,25 +73,25 @@ and the core application (meeting object) in the main window. -### meeting.plugins.all.get(pluginId).enable() +### plugin.enable() Enable this plugin for the current user. **Kind**: instance method of [DytePlugin](#module_DytePlugin) -### meeting.plugins.all.get(pluginId).disable() +### plugin.disable() Disable this plugin for the current user. **Kind**: instance method of [DytePlugin](#module_DytePlugin) -### meeting.plugins.all.get(pluginId).activate() +### plugin.activate() Activate this plugin for all participants. **Kind**: instance method of [DytePlugin](#module_DytePlugin) -### meeting.plugins.all.get(pluginId).deactivate() +### plugin.deactivate() Deactivate this plugin for all participants. **Kind**: instance method of [DytePlugin](#module_DytePlugin) diff --git a/docs/react-web-core/Reference/DytePluginMap.md b/docs/react-web-core/Reference/DytePluginMap.md index d17235e716..9e30899cb4 100644 --- a/docs/react-web-core/Reference/DytePluginMap.md +++ b/docs/react-web-core/Reference/DytePluginMap.md @@ -1,6 +1,6 @@ --- -sidebar_position: 10 -web_core_version: 0.18.0 +sidebar_position: 11 +web_core_version: 0.24.0 --- @@ -13,4 +13,3 @@ For example, when a plugin is added to this map, a `pluginAdded` event is emitted from the map. When a plugin object emits an event `stateUpdate`, the map re-emits that event (provided the plugin is present in the map). - diff --git a/docs/react-web-core/Reference/DytePlugins.md b/docs/react-web-core/Reference/DytePlugins.md index 72372a72ef..7c17d44585 100644 --- a/docs/react-web-core/Reference/DytePlugins.md +++ b/docs/react-web-core/Reference/DytePlugins.md @@ -1,6 +1,6 @@ --- -sidebar_position: 9 -web_core_version: 0.18.0 +sidebar_position: 10 +web_core_version: 0.24.0 --- diff --git a/docs/react-web-core/Reference/DytePolls.md b/docs/react-web-core/Reference/DytePolls.md index 70e2507da8..f4d76cdc63 100644 --- a/docs/react-web-core/Reference/DytePolls.md +++ b/docs/react-web-core/Reference/DytePolls.md @@ -1,6 +1,6 @@ --- -sidebar_position: 8 -web_core_version: 0.18.0 +sidebar_position: 9 +web_core_version: 0.24.0 --- diff --git a/docs/react-web-core/Reference/DyteRecording.md b/docs/react-web-core/Reference/DyteRecording.md new file mode 100644 index 0000000000..52c2450c12 --- /dev/null +++ b/docs/react-web-core/Reference/DyteRecording.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 15 +web_core_version: 0.24.0 +--- + + + + + +The DyteRecording module represents the state of the current recording, and allows +to start/stop recordings and check if there's a recording in progress. + + +* [DyteRecording](#module_DyteRecording) + * [.recordingId](#module_DyteRecording+recordingId) + * [.start()](#module_DyteRecording+start) + * [.stop()](#module_DyteRecording+stop) + * [.refreshActiveRecordingState()](#module_DyteRecording+refreshActiveRecordingState) + + + +### meeting.recording.recordingId +NOTE(CallMeTarush): +Not setting recording state here, waiting for recording +peer to join to set state automatically + +**Kind**: instance property of [DyteRecording](#module_DyteRecording) + + +### meeting.recording.start() +Starts recording the meeting. + +**Kind**: instance method of [DyteRecording](#module_DyteRecording) + + +### meeting.recording.stop() +Stops recording the meeting assuming there +is a recording in progress. + +**Kind**: instance method of [DyteRecording](#module_DyteRecording) + + +### meeting.recording.refreshActiveRecordingState() +Refreshes current recording state. + +**Kind**: instance method of [DyteRecording](#module_DyteRecording) diff --git a/docs/react-web-core/Reference/DyteRemote.md b/docs/react-web-core/Reference/DyteRemote.md new file mode 100644 index 0000000000..1122007cba --- /dev/null +++ b/docs/react-web-core/Reference/DyteRemote.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 14 +web_core_version: 0.24.0 +--- + + + + + +This module provides the ability to control a remotely shared screen using mouse and keyboard. +Methods are available to request, accept and end control of shared screen. + + +* [DyteRemote](#module_DyteRemote) + * [.requestControl(peerId)](#module_DyteRemote+requestControl) ⇒ + * [.acceptControl(requestId)](#module_DyteRemote+acceptControl) + * [.endControl()](#module_DyteRemote+endControl) + + + +### meeting.remote.requestControl(peerId) ⇒ +Sends a request to a peer for remote control. + +**Kind**: instance method of [DyteRemote](#module_DyteRemote) +**Returns**: request identifier for the control request. + +| Param | Description | +| --- | --- | +| peerId | The peer that needs to receive the remote control request | + + + +### meeting.remote.acceptControl(requestId) +Accepts a remote control request from a peer. + +**Kind**: instance method of [DyteRemote](#module_DyteRemote) + +| Param | Description | +| --- | --- | +| requestId | The request identifier that needs to be accepted | + + + +### meeting.remote.endControl() +End an active remote control. + +**Kind**: instance method of [DyteRemote](#module_DyteRemote) diff --git a/docs/react-web-core/Reference/DyteSelf.md b/docs/react-web-core/Reference/DyteSelf.md index 65fc6e2e0a..435d9e99d4 100644 --- a/docs/react-web-core/Reference/DyteSelf.md +++ b/docs/react-web-core/Reference/DyteSelf.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -web_core_version: 0.18.0 +web_core_version: 0.24.0 --- @@ -14,7 +14,9 @@ this module. * [DyteSelf](#module_DyteSelf) * [.audioTrack](#module_DyteSelf+audioTrack) + * [.rawAudioTrack](#module_DyteSelf+rawAudioTrack) * [.videoTrack](#module_DyteSelf+videoTrack) + * [.rawVideoTrack](#module_DyteSelf+rawVideoTrack) * [.screenShareTracks](#module_DyteSelf+screenShareTracks) * [.audioEnabled](#module_DyteSelf+audioEnabled) * [.videoEnabled](#module_DyteSelf+videoEnabled) @@ -23,6 +25,10 @@ this module. * [.permissions](#module_DyteSelf+permissions) * [.suggestedTheme](#module_DyteSelf+suggestedTheme) * [.roomJoined](#module_DyteSelf+roomJoined) + * [.addAudioMiddleware()](#module_DyteSelf+addAudioMiddleware) + * [.removeAudioMiddleware()](#module_DyteSelf+removeAudioMiddleware) + * [.addVideoMiddleware()](#module_DyteSelf+addVideoMiddleware) + * [.removeVideoMiddleware()](#module_DyteSelf+removeVideoMiddleware) * [.setName(name)](#module_DyteSelf+setName) * [.setupTracks(options)](#module_DyteSelf+setupTracks) * [.enableAudio()](#module_DyteSelf+enableAudio) @@ -39,6 +45,9 @@ this module. * [.getSpeakerDevices()](#module_DyteSelf+getSpeakerDevices) * [.getDeviceById(deviceId, kind)](#module_DyteSelf+getDeviceById) * [.getAllDevices()](#module_DyteSelf+getAllDevices) + * [.pinned()](#module_DyteSelf+pinned) + * [.pin()](#module_DyteSelf+pin) + * [.unpin()](#module_DyteSelf+unpin) * [.setDevice(device, preview)](#module_DyteSelf+setDevice) @@ -46,12 +55,24 @@ this module. ### meeting.self.audioTrack Returns the `audioTrack`. +**Kind**: instance property of [DyteSelf](#module_DyteSelf) + + +### meeting.self.rawAudioTrack +Returns the `rawAudioTrack` having no middleware executed on it. + **Kind**: instance property of [DyteSelf](#module_DyteSelf) ### meeting.self.videoTrack Returns the `videoTrack`. +**Kind**: instance property of [DyteSelf](#module_DyteSelf) + + +### meeting.self.rawVideoTrack +Returns the `videoTrack` having no middleware executed on it. + **Kind**: instance property of [DyteSelf](#module_DyteSelf) @@ -105,6 +126,36 @@ Returns suggested theme for the meeting. Returns true if the local participant has joined the meeting. **Kind**: instance property of [DyteSelf](#module_DyteSelf) + + +### meeting.self.addAudioMiddleware() +Adds the audio middleware to be executed on the raw audio stream. +If there are more than 1 audio middlewares, +they will be executed in the sequence they were added in. +If you want the sequence to be altered, please remove all previous middlewares and re-add. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.removeAudioMiddleware() +Removes the audio middleware, if it is there. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.addVideoMiddleware() +Adds the video middleware to be executed on the raw video stream. +If there are more than 1 video middlewares, +they will be executed in the sequence they were added in. +If you want the sequence to be altered, please remove all previous middlewares and re-add. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.removeVideoMiddleware() +Removes the video middleware, if it is there. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) ### meeting.self.setName(name) @@ -231,6 +282,24 @@ Returns the local participant's device, indexed by ID and kind. ### meeting.self.getAllDevices() Returns all media devices accessible by the local participant. +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.pinned() +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.pin() +Returns `self.id` if user has permission +to pin participants. + +**Kind**: instance method of [DyteSelf](#module_DyteSelf) + + +### meeting.self.unpin() +Returns `self.id` if user has permission +to unpin participants. + **Kind**: instance method of [DyteSelf](#module_DyteSelf) diff --git a/docs/react-web-core/Reference/DyteThemePreset.md b/docs/react-web-core/Reference/DyteThemePreset.md new file mode 100644 index 0000000000..a1d80c176e --- /dev/null +++ b/docs/react-web-core/Reference/DyteThemePreset.md @@ -0,0 +1,86 @@ +--- +sidebar_position: 13 +web_core_version: 0.24.0 +--- + + + + + +The DyteThemePreset class represents the meeting theme for the current participant + + +* [DyteThemePreset](#module_DyteThemePreset) + * [.setupScreen](#module_DyteThemePreset+setupScreen) + * [.aloneHere](#module_DyteThemePreset+aloneHere) + * [.waitingRoom](#module_DyteThemePreset+waitingRoom) + * [.controlBar](#module_DyteThemePreset+controlBar) + * [.header](#module_DyteThemePreset+header) + * [.pipMode](#module_DyteThemePreset+pipMode) + * [.autoTune](#module_DyteThemePreset+autoTune) + * [.grid](#module_DyteThemePreset+grid) + + + +### meeting.self.suggestedTheme.setupScreen +The `setupScreen` represents the setup screen for the meeting. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.aloneHere +The `aloneHere` contains the properties to show a layout when +the participant is alone in the meeting. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.waitingRoom +The `waitingRoom` contains the properties to show a layout when +the participant is in waiting to join the meeting. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.controlBar +The `controlBar` contains the properties to show the meeting control bar with +various action buttons for the meeting. +The `elements` key contains the various action buttons. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.header +The `header` contains the properties to show the meeting header with various elements. +The `elements` key contains the following properties +`logo` - string value representing the public URL for the logo +`timer` - boolean value suggesting if the timer should be shown +`title` - boolean value suggesting if the meeting title should be shown +`participantCount` - boolean value suggesting if the participant count shuld be shown +`changeLayout` - boolean value suggesting if the participant can change layout + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.pipMode +The `pipMode` property returns a boolean value +If true, picture-in-picture mode is enabled for the participant. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.autoTune +The `autoTune` property returns a boolean value +If true, force the participant's video to be in compatibility mode. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) + + +### meeting.self.suggestedTheme.grid +The `grid` contains the properties to show participant grid for the meeting. +`defaultView` key points to the view type, possible values are `MULTI`, `SINGLE` +`multi` and `single` keys contain the following preferences to show grid layout. +`maxVideoCount` - number of participants to show in the grid. +`videoFit` - string value suggesting how to align the video content. + +**Kind**: instance property of [DyteThemePreset](#module_DyteThemePreset) From 39ba4529d0ca3a3e28b934f48f706a9f72cb91a7 Mon Sep 17 00:00:00 2001 From: alias-rahil Date: Mon, 20 Jun 2022 11:29:40 +0530 Subject: [PATCH 2/9] feat: add workflow to reject pr if api-specs is updated --- .github/workflows/update-api-specs-check.yml | 37 ++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/workflows/update-api-specs-check.yml diff --git a/.github/workflows/update-api-specs-check.yml b/.github/workflows/update-api-specs-check.yml new file mode 100644 index 0000000000..524b27bf05 --- /dev/null +++ b/.github/workflows/update-api-specs-check.yml @@ -0,0 +1,37 @@ +name: Update API Specs Check + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + update-api-specs-check: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Get changed files + id: changed-files + uses: tj-actions/changed-files@v23 + with: + since_last_remote_commit: true + files_separator: "," + files: static/api/v1.yaml,static/api/v2.yaml + + - name: Fail workflow if api specs has updated - comment err msg on PR + if: steps.changed-files.outputs.only_changed == 'true' && github.event_name == 'pull_request' + env: + PR_NUMBER: ${{ github.event.pull_request.number }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh pr comment $PR_NUMBER --body 'Avoid updating the api-specs directly. They will be overwritten.' && exit 1 + + - name: Fail workflow if api specs has updated - echo err msg + if: steps.changed-files.outputs.only_changed == 'true' && github.event_name != 'pull_request' + run: echo 'Avoid updating the api-specs directly. They will be overwritten.' && exit 1 From 28ca5499e0e1f6aee7ba197afe5a6139a61d1646 Mon Sep 17 00:00:00 2001 From: Rohan Mukherjee Date: Fri, 24 Jun 2022 17:41:32 +0530 Subject: [PATCH 3/9] fix: web-core docs (#35) * chore(release): 1.12.2 [skip ci] ## [1.12.2](https://github.com/dyte-in/docs/compare/v1.12.1...v1.12.2) (2022-06-09) ### Bug Fixes * update reference for react-native-core and react-web-core ([3316430](https://github.com/dyte-in/docs/commit/331643034d7935c838f66ca062e82bcd1e701ce5)) skip-checks: true * feat: added docs for version 0.25.x of web-core * fix: remove unused function * fix: update web-core docs to v0.26.0 * fix: update web-core docs to v0.26.0 * chore(release): 1.13.0 [skip ci] # [1.13.0](https://github.com/dyte-in/docs/compare/v1.12.2...v1.13.0) (2022-06-13) ### Bug Fixes * remove unused function ([b14a696](https://github.com/dyte-in/docs/commit/b14a6960c8d1acb63d4cdfe18420a554b75c1ae3)) * update web-core docs to v0.26.0 ([6cb5952](https://github.com/dyte-in/docs/commit/6cb59528267358af8281bc3c43bcec75cb31643e)) * update web-core docs to v0.26.0 ([bf924a4](https://github.com/dyte-in/docs/commit/bf924a47141fe58ab3cc1389054fc3a1f5353349)) ### Features * added docs for version 0.25.x of web-core ([b2479f3](https://github.com/dyte-in/docs/commit/b2479f388499bd898ba63d5f71c74fa870419b80)) skip-checks: true * fix: patch-package for Basic Auth Description fix: update package-lock * chore(release): 1.13.1 [skip ci] ## [1.13.1](https://github.com/dyte-in/docs/compare/v1.13.0...v1.13.1) (2022-06-15) ### Bug Fixes * patch-package for Basic Auth Description ([a525172](https://github.com/dyte-in/docs/commit/a5251722ccdc6d543dadac72e56f8b4e49f452fa)) skip-checks: true * feat: update v2 api spec * fix: patch-package for basic auth fields * chore(release): 1.14.0 [skip ci] # [1.14.0](https://github.com/dyte-in/docs/compare/v1.13.1...v1.14.0) (2022-06-16) ### Bug Fixes * patch-package for basic auth fields ([6f25082](https://github.com/dyte-in/docs/commit/6f2508283684b2141fdd52223dbf9c3539771199)) ### Features * update v2 api spec ([df6dd56](https://github.com/dyte-in/docs/commit/df6dd56832adf6f91f2b1e0001ce2c090a262f8c)) skip-checks: true * fix(src/theme/navbar/index.js): fix the wrong validation for mobile sdks in navbar The validation for the color of navbar was wrong for mobile-sdks page which was web-sdk earlier. #58 * chore(release): 1.14.1 [skip ci] ## [1.14.1](https://github.com/dyte-in/docs/compare/v1.14.0...v1.14.1) (2022-06-23) ### Bug Fixes * **src/theme/navbar/index.js:** fix the wrong validation for mobile sdks in navbar ([f0a98d6](https://github.com/dyte-in/docs/commit/f0a98d614b64632f3a1144af580159246c31dc42)), closes [#58](https://github.com/dyte-in/docs/issues/58) skip-checks: true * fix: hide old SDKs from the navigation * fix: linting * fix: navbar icon links placement in mobile * chore(release): 1.14.2 [skip ci] ## [1.14.2](https://github.com/dyte-in/docs/compare/v1.14.1...v1.14.2) (2022-06-24) ### Bug Fixes * hide old SDKs from the navigation ([2633a15](https://github.com/dyte-in/docs/commit/2633a15a75bca2b3af22e375d3b8f291a78898c9)) * linting ([bc372a8](https://github.com/dyte-in/docs/commit/bc372a86ada5fc95b290a74b2510bd79281cc287)) * navbar icon links placement in mobile ([a3b25e9](https://github.com/dyte-in/docs/commit/a3b25e9f9a39ff9c33a1171717eb8fda92346047)) skip-checks: true * fix: replace Old SDKs from sidebar * fix: added recording guide * chore(release): 1.14.3 [skip ci] ## [1.14.3](https://github.com/dyte-in/docs/compare/v1.14.2...v1.14.3) (2022-06-24) ### Bug Fixes * replace Old SDKs from sidebar ([0d2bff0](https://github.com/dyte-in/docs/commit/0d2bff015eaf3fe172ce833e657f0283c1140368)) skip-checks: true Co-authored-by: semantic-release-bot Co-authored-by: Vaibhav Shinde Co-authored-by: Shoury Sharma Co-authored-by: Palash --- CHANGELOG.md | 63 +++ docs/react-native-core/Reference/DyteChat.md | 2 +- .../react-native-core/Reference/DyteClient.md | 2 +- docs/react-native-core/Reference/DyteMeta.md | 32 +- .../Reference/DyteParticipant.md | 30 +- .../Reference/DyteParticipantMap.md | 2 +- .../Reference/DyteParticipants.md | 25 +- .../Reference/DytePermissionsPreset.md | 2 +- .../react-native-core/Reference/DytePlugin.md | 2 +- .../Reference/DytePluginMap.md | 2 +- .../Reference/DytePlugins.md | 2 +- docs/react-native-core/Reference/DytePolls.md | 2 +- .../Reference/DyteRecording.md | 2 +- .../react-native-core/Reference/DyteRemote.md | 2 +- docs/react-native-core/Reference/DyteSelf.md | 15 +- .../Reference/DyteThemePreset.md | 2 +- docs/react-web-core/Reference/DyteChat.md | 2 +- docs/react-web-core/Reference/DyteClient.md | 2 +- docs/react-web-core/Reference/DyteMeta.md | 32 +- .../Reference/DyteParticipant.md | 30 +- .../Reference/DyteParticipantMap.md | 2 +- .../Reference/DyteParticipants.md | 25 +- .../Reference/DytePermissionsPreset.md | 2 +- docs/react-web-core/Reference/DytePlugin.md | 2 +- .../react-web-core/Reference/DytePluginMap.md | 2 +- docs/react-web-core/Reference/DytePlugins.md | 2 +- docs/react-web-core/Reference/DytePolls.md | 2 +- .../react-web-core/Reference/DyteRecording.md | 2 +- docs/react-web-core/Reference/DyteRemote.md | 2 +- docs/react-web-core/Reference/DyteSelf.md | 15 +- .../Reference/DyteThemePreset.md | 2 +- ...2-installation.mdx => 01-installation.mdx} | 2 +- .../{01-quickstart.md => 02-quickstart.md} | 0 .../01-introduction.mdx | 0 .../02-events.mdx | 0 .../03-manage-media-devices.mdx | 0 .../01-participants.mdx} | 26 +- docs/web-core/05-Participants/02-events.mdx | 120 +++++ docs/web-core/09-recording.mdx | 32 ++ docs/web-core/Reference/DyteChat.md | 2 +- docs/web-core/Reference/DyteClient.md | 2 +- docs/web-core/Reference/DyteMeta.md | 32 +- docs/web-core/Reference/DyteParticipant.md | 30 +- docs/web-core/Reference/DyteParticipantMap.md | 2 +- docs/web-core/Reference/DyteParticipants.md | 25 +- .../Reference/DytePermissionsPreset.md | 2 +- docs/web-core/Reference/DytePlugin.md | 2 +- docs/web-core/Reference/DytePluginMap.md | 2 +- docs/web-core/Reference/DytePlugins.md | 2 +- docs/web-core/Reference/DytePolls.md | 2 +- docs/web-core/Reference/DyteRecording.md | 2 +- docs/web-core/Reference/DyteRemote.md | 2 +- docs/web-core/Reference/DyteSelf.md | 15 +- docs/web-core/Reference/DyteThemePreset.md | 2 +- docusaurus.config.js | 6 +- package-lock.json | 474 +++++++++++++++++- package.json | 6 +- patches/@stoplight+elements-core+7.4.0.patch | 105 ++++ sidebars/sidebars-docs.js | 15 +- src/theme/Navbar/index.js | 45 +- src/theme/SearchBar/styles.module.css | 7 - src/utils/constants.ts | 19 +- static/api/v2.yaml | 45 +- .../version-0.25.x/01-installation.mdx | 47 ++ .../version-0.25.x/02-quickstart.md | 22 + .../03-Local User/01-introduction.mdx | 115 +++++ .../03-Local User/02-events.mdx | 90 ++++ .../03-Local User/03-manage-media-devices.mdx | 35 ++ .../version-0.25.x/04-room-metadata.mdx | 38 ++ .../05-Participants/01-participants.mdx | 74 +++ .../05-Participants/02-events.mdx | 120 +++++ .../06-Chat/01-introduction.mdx | 43 ++ .../06-Chat/02-sending-a-chat-message.mdx | 72 +++ .../06-Chat/03-receiving-chat-messages.mdx | 28 ++ .../06-Chat/04-other-chat-functions.mdx | 62 +++ .../07-Polls/01-introduction.mdx | 35 ++ .../07-Polls/02-creating-a-poll.mdx | 27 + .../07-Polls/03-voting-on-a-poll.mdx | 22 + .../07-Polls/04-other-poll-functions.mdx | 39 ++ .../08-Plugins/01-introduction.mdx | 74 +++ .../08-Plugins/02-enable-plugin.mdx | 60 +++ .../08-Plugins/03-disable-plugin.mdx | 58 +++ .../version-0.25.x/Reference/DyteChat.md | 126 +++++ .../version-0.25.x/Reference/DyteClient.md | 113 +++++ .../version-0.25.x/Reference/DyteMeta.md | 49 ++ .../Reference/DyteParticipant.md | 114 +++++ .../Reference/DyteParticipantMap.md | 15 + .../Reference/DyteParticipants.md | 229 +++++++++ .../Reference/DytePermissionsPreset.md | 221 ++++++++ .../version-0.25.x/Reference/DytePlugin.md | 97 ++++ .../version-0.25.x/Reference/DytePluginMap.md | 15 + .../version-0.25.x/Reference/DytePlugins.md | 30 ++ .../version-0.25.x/Reference/DytePolls.md | 49 ++ .../version-0.25.x/Reference/DyteRecording.md | 46 ++ .../version-0.25.x/Reference/DyteRemote.md | 47 ++ .../version-0.25.x/Reference/DyteSelf.md | 315 ++++++++++++ .../Reference/DyteThemePreset.md | 86 ++++ .../version-0.26.x/01-installation.mdx | 47 ++ .../version-0.26.x/02-quickstart.md | 22 + .../03-Local User/01-introduction.mdx | 115 +++++ .../03-Local User/02-events.mdx | 90 ++++ .../03-Local User/03-manage-media-devices.mdx | 35 ++ .../version-0.26.x/04-room-metadata.mdx | 38 ++ .../05-Participants/01-participants.mdx | 74 +++ .../05-Participants/02-events.mdx | 120 +++++ .../06-Chat/01-introduction.mdx | 43 ++ .../06-Chat/02-sending-a-chat-message.mdx | 72 +++ .../06-Chat/03-receiving-chat-messages.mdx | 28 ++ .../06-Chat/04-other-chat-functions.mdx | 62 +++ .../07-Polls/01-introduction.mdx | 35 ++ .../07-Polls/02-creating-a-poll.mdx | 27 + .../07-Polls/03-voting-on-a-poll.mdx | 22 + .../07-Polls/04-other-poll-functions.mdx | 39 ++ .../08-Plugins/01-introduction.mdx | 74 +++ .../08-Plugins/02-enable-plugin.mdx | 60 +++ .../08-Plugins/03-disable-plugin.mdx | 58 +++ .../version-0.26.x/Reference/DyteChat.md | 126 +++++ .../version-0.26.x/Reference/DyteClient.md | 110 ++++ .../version-0.26.x/Reference/DyteMeta.md | 49 ++ .../Reference/DyteParticipant.md | 142 ++++++ .../Reference/DyteParticipantMap.md | 15 + .../Reference/DyteParticipants.md | 220 ++++++++ .../Reference/DytePermissionsPreset.md | 221 ++++++++ .../version-0.26.x/Reference/DytePlugin.md | 97 ++++ .../version-0.26.x/Reference/DytePluginMap.md | 15 + .../version-0.26.x/Reference/DytePlugins.md | 30 ++ .../version-0.26.x/Reference/DytePolls.md | 49 ++ .../version-0.26.x/Reference/DyteRecording.md | 46 ++ .../version-0.26.x/Reference/DyteRemote.md | 47 ++ .../version-0.26.x/Reference/DyteSelf.md | 322 ++++++++++++ .../Reference/DyteThemePreset.md | 86 ++++ .../version-0.25.x-sidebars.json | 8 + .../version-0.26.x-sidebars.json | 8 + web-core_versions.json | 2 + 134 files changed, 6336 insertions(+), 268 deletions(-) rename docs/web-core/{02-installation.mdx => 01-installation.mdx} (93%) rename docs/web-core/{01-quickstart.md => 02-quickstart.md} (100%) rename docs/web-core/{03-LocalUser => 03-Local User}/01-introduction.mdx (100%) rename docs/web-core/{03-LocalUser => 03-Local User}/02-events.mdx (100%) rename docs/web-core/{03-LocalUser => 03-Local User}/03-manage-media-devices.mdx (100%) rename docs/web-core/{05-participants.mdx => 05-Participants/01-participants.mdx} (80%) create mode 100644 docs/web-core/05-Participants/02-events.mdx create mode 100644 docs/web-core/09-recording.mdx create mode 100644 patches/@stoplight+elements-core+7.4.0.patch create mode 100644 web-core_versioned_docs/version-0.25.x/01-installation.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/02-quickstart.md create mode 100644 web-core_versioned_docs/version-0.25.x/03-Local User/01-introduction.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/03-Local User/02-events.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/03-Local User/03-manage-media-devices.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/04-room-metadata.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/05-Participants/01-participants.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/05-Participants/02-events.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/06-Chat/01-introduction.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/06-Chat/02-sending-a-chat-message.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/06-Chat/03-receiving-chat-messages.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/06-Chat/04-other-chat-functions.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/07-Polls/01-introduction.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/07-Polls/02-creating-a-poll.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/07-Polls/03-voting-on-a-poll.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/07-Polls/04-other-poll-functions.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/08-Plugins/01-introduction.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/08-Plugins/02-enable-plugin.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/08-Plugins/03-disable-plugin.mdx create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteChat.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteClient.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteMeta.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteParticipant.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteParticipantMap.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteParticipants.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DytePermissionsPreset.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DytePlugin.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DytePluginMap.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DytePlugins.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DytePolls.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteRecording.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteRemote.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteSelf.md create mode 100644 web-core_versioned_docs/version-0.25.x/Reference/DyteThemePreset.md create mode 100644 web-core_versioned_docs/version-0.26.x/01-installation.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/02-quickstart.md create mode 100644 web-core_versioned_docs/version-0.26.x/03-Local User/01-introduction.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/03-Local User/02-events.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/03-Local User/03-manage-media-devices.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/04-room-metadata.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/05-Participants/01-participants.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/05-Participants/02-events.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/06-Chat/01-introduction.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/06-Chat/02-sending-a-chat-message.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/06-Chat/03-receiving-chat-messages.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/06-Chat/04-other-chat-functions.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/07-Polls/01-introduction.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/07-Polls/02-creating-a-poll.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/07-Polls/03-voting-on-a-poll.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/07-Polls/04-other-poll-functions.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/08-Plugins/01-introduction.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/08-Plugins/02-enable-plugin.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/08-Plugins/03-disable-plugin.mdx create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteChat.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteClient.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteMeta.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteParticipant.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteParticipantMap.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteParticipants.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DytePermissionsPreset.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DytePlugin.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DytePluginMap.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DytePlugins.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DytePolls.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteRecording.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteRemote.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteSelf.md create mode 100644 web-core_versioned_docs/version-0.26.x/Reference/DyteThemePreset.md create mode 100644 web-core_versioned_sidebars/version-0.25.x-sidebars.json create mode 100644 web-core_versioned_sidebars/version-0.26.x-sidebars.json diff --git a/CHANGELOG.md b/CHANGELOG.md index 788a90e48e..e6622cf8f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,66 @@ +## [1.14.3](https://github.com/dyte-in/docs/compare/v1.14.2...v1.14.3) (2022-06-24) + + +### Bug Fixes + +* replace Old SDKs from sidebar ([0d2bff0](https://github.com/dyte-in/docs/commit/0d2bff015eaf3fe172ce833e657f0283c1140368)) + +## [1.14.2](https://github.com/dyte-in/docs/compare/v1.14.1...v1.14.2) (2022-06-24) + + +### Bug Fixes + +* hide old SDKs from the navigation ([2633a15](https://github.com/dyte-in/docs/commit/2633a15a75bca2b3af22e375d3b8f291a78898c9)) +* linting ([bc372a8](https://github.com/dyte-in/docs/commit/bc372a86ada5fc95b290a74b2510bd79281cc287)) +* navbar icon links placement in mobile ([a3b25e9](https://github.com/dyte-in/docs/commit/a3b25e9f9a39ff9c33a1171717eb8fda92346047)) + +## [1.14.1](https://github.com/dyte-in/docs/compare/v1.14.0...v1.14.1) (2022-06-23) + + +### Bug Fixes + +* **src/theme/navbar/index.js:** fix the wrong validation for mobile sdks in navbar ([f0a98d6](https://github.com/dyte-in/docs/commit/f0a98d614b64632f3a1144af580159246c31dc42)), closes [#58](https://github.com/dyte-in/docs/issues/58) + +# [1.14.0](https://github.com/dyte-in/docs/compare/v1.13.1...v1.14.0) (2022-06-16) + + +### Bug Fixes + +* patch-package for basic auth fields ([6f25082](https://github.com/dyte-in/docs/commit/6f2508283684b2141fdd52223dbf9c3539771199)) + + +### Features + +* update v2 api spec ([df6dd56](https://github.com/dyte-in/docs/commit/df6dd56832adf6f91f2b1e0001ce2c090a262f8c)) + +## [1.13.1](https://github.com/dyte-in/docs/compare/v1.13.0...v1.13.1) (2022-06-15) + + +### Bug Fixes + +* patch-package for Basic Auth Description ([a525172](https://github.com/dyte-in/docs/commit/a5251722ccdc6d543dadac72e56f8b4e49f452fa)) + +# [1.13.0](https://github.com/dyte-in/docs/compare/v1.12.2...v1.13.0) (2022-06-13) + + +### Bug Fixes + +* remove unused function ([b14a696](https://github.com/dyte-in/docs/commit/b14a6960c8d1acb63d4cdfe18420a554b75c1ae3)) +* update web-core docs to v0.26.0 ([6cb5952](https://github.com/dyte-in/docs/commit/6cb59528267358af8281bc3c43bcec75cb31643e)) +* update web-core docs to v0.26.0 ([bf924a4](https://github.com/dyte-in/docs/commit/bf924a47141fe58ab3cc1389054fc3a1f5353349)) + + +### Features + +* added docs for version 0.25.x of web-core ([b2479f3](https://github.com/dyte-in/docs/commit/b2479f388499bd898ba63d5f71c74fa870419b80)) + +## [1.12.2](https://github.com/dyte-in/docs/compare/v1.12.1...v1.12.2) (2022-06-09) + + +### Bug Fixes + +* update reference for react-native-core and react-web-core ([3316430](https://github.com/dyte-in/docs/commit/331643034d7935c838f66ca062e82bcd1e701ce5)) + ## [1.12.1](https://github.com/dyte-in/docs/compare/v1.12.0...v1.12.1) (2022-06-09) diff --git a/docs/react-native-core/Reference/DyteChat.md b/docs/react-native-core/Reference/DyteChat.md index 3f8c348cd0..37e7061755 100644 --- a/docs/react-native-core/Reference/DyteChat.md +++ b/docs/react-native-core/Reference/DyteChat.md @@ -1,6 +1,6 @@ --- sidebar_position: 8 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DyteClient.md b/docs/react-native-core/Reference/DyteClient.md index 4eb06dcf2b..0638fdc650 100644 --- a/docs/react-native-core/Reference/DyteClient.md +++ b/docs/react-native-core/Reference/DyteClient.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DyteMeta.md b/docs/react-native-core/Reference/DyteMeta.md index d9ded826a7..c76444330a 100644 --- a/docs/react-native-core/Reference/DyteMeta.md +++ b/docs/react-native-core/Reference/DyteMeta.md @@ -1,6 +1,6 @@ --- sidebar_position: 7 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- @@ -11,16 +11,22 @@ This consists of the metadata of the meeting, such as the room name and the titl * [DyteMeta](#module_DyteMeta) - * [.roomName](#module_DyteMeta+roomName) - * [.joined](#module_DyteMeta+joined) * [.roomType](#module_DyteMeta+roomType) - * [.meetingTitle](#module_DyteMeta+meetingTitle) * [.meetingStartedTimestamp](#module_DyteMeta+meetingStartedTimestamp) + * [.joined](#module_DyteMeta+joined) + * [.roomName](#module_DyteMeta+roomName) + * [.meetingTitle](#module_DyteMeta+meetingTitle) - + -### meeting.meta.roomName -The room name of the meeting. +### meeting.meta.roomType +Indicates the meeting is a group-call or a webinar. + +**Kind**: instance property of [DyteMeta](#module_DyteMeta) + + +### meeting.meta.meetingStartedTimestamp +The timestamp of the time when the meeting started. **Kind**: instance property of [DyteMeta](#module_DyteMeta) @@ -29,10 +35,10 @@ The room name of the meeting. This is set to true if the current user has joined the meeting. **Kind**: instance property of [DyteMeta](#module_DyteMeta) - + -### meeting.meta.roomType -Indicates the meeting is a group-call or a webinar. +### meeting.meta.roomName +The room name of the meeting. **Kind**: instance property of [DyteMeta](#module_DyteMeta) @@ -41,9 +47,3 @@ Indicates the meeting is a group-call or a webinar. The title of the meeting. **Kind**: instance property of [DyteMeta](#module_DyteMeta) - - -### meeting.meta.meetingStartedTimestamp -The timestamp of the time when the meeting started. - -**Kind**: instance property of [DyteMeta](#module_DyteMeta) diff --git a/docs/react-native-core/Reference/DyteParticipant.md b/docs/react-native-core/Reference/DyteParticipant.md index 572122e555..1901a99442 100644 --- a/docs/react-native-core/Reference/DyteParticipant.md +++ b/docs/react-native-core/Reference/DyteParticipant.md @@ -1,6 +1,6 @@ --- sidebar_position: 5 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- @@ -32,6 +32,10 @@ const participant4 = meeting.participants.active.toArray().filter((p) => p.name * [.audioEnabled](#module_DyteParticipant+audioEnabled) * [.screenShareEnabled](#module_DyteParticipant+screenShareEnabled) * [.supportsRemoteControl](#module_DyteParticipant+supportsRemoteControl) + * [.isPinned](#module_DyteParticipant+isPinned) + * [.pin()](#module_DyteParticipant+pin) + * [.unpin()](#module_DyteParticipant+unpin) + * [.setIsPinned()](#module_DyteParticipant+setIsPinned) @@ -112,3 +116,27 @@ This is true if the participant is screensharing. This is true if the dyte participant supports remote control. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) + + +### participant.isPinned +Returns true if the participant is pinned. + +**Kind**: instance property of [DyteParticipant](#module_DyteParticipant) + + +### participant.pin() +Returns `participant.id` if user has permission +to pin participants. + +**Kind**: instance method of [DyteParticipant](#module_DyteParticipant) + + +### participant.unpin() +Returns `participant.id` if user has permission +to unpin participants. + +**Kind**: instance method of [DyteParticipant](#module_DyteParticipant) + + +### participant.setIsPinned() +**Kind**: instance method of [DyteParticipant](#module_DyteParticipant) diff --git a/docs/react-native-core/Reference/DyteParticipantMap.md b/docs/react-native-core/Reference/DyteParticipantMap.md index 6e0cb6c23c..9b9706711a 100644 --- a/docs/react-native-core/Reference/DyteParticipantMap.md +++ b/docs/react-native-core/Reference/DyteParticipantMap.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DyteParticipants.md b/docs/react-native-core/Reference/DyteParticipants.md index 927fde2fc1..58642c1a1d 100644 --- a/docs/react-native-core/Reference/DyteParticipants.md +++ b/docs/react-native-core/Reference/DyteParticipants.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- @@ -29,13 +29,12 @@ This module represents all the participants in the meeting. It consists of 4 map * [.rejectWaitingRoomRequest(id)](#module_DyteParticipants+rejectWaitingRoomRequest) * [.setViewMode(viewMode)](#module_DyteParticipants+setViewMode) * [.setPage(page)](#module_DyteParticipants+setPage) - * [.pin()](#module_DyteParticipants+pin) - * [.unpin()](#module_DyteParticipants+unpin) * [.disableAllAudio(allowUnMute)](#module_DyteParticipants+disableAllAudio) * [.disableAllVideo()](#module_DyteParticipants+disableAllVideo) * [.disableAudio(peerId)](#module_DyteParticipants+disableAudio) * [.disableVideo(peerId)](#module_DyteParticipants+disableVideo) * [.kickAll()](#module_DyteParticipants+kickAll) + * [.broadcastMessage()](#module_DyteParticipants+broadcastMessage) * [.kick(peerId)](#module_DyteParticipants+kick) @@ -157,20 +156,6 @@ Does not do anything in ACTIVE_GRID mode. | --- | --- | | page | The page number to be set. | - - -### meeting.participants.pin() -Returns `participant.id` if user has permission -to pin participants. - -**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) - - -### meeting.participants.unpin() -Returns `participant.id` if user has permission -to unpin participants. - -**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) ### meeting.participants.disableAllAudio(allowUnMute) @@ -215,6 +200,12 @@ Disables video for the given participant. ### meeting.participants.kickAll() Kicks all participants from the meeting. +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) + + +### meeting.participants.broadcastMessage() +Broadcasts the message to all participants including `self`. + **Kind**: instance method of [DyteParticipants](#module_DyteParticipants) diff --git a/docs/react-native-core/Reference/DytePermissionsPreset.md b/docs/react-native-core/Reference/DytePermissionsPreset.md index a94bc787ad..5119b69383 100644 --- a/docs/react-native-core/Reference/DytePermissionsPreset.md +++ b/docs/react-native-core/Reference/DytePermissionsPreset.md @@ -1,6 +1,6 @@ --- sidebar_position: 6 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DytePlugin.md b/docs/react-native-core/Reference/DytePlugin.md index 9513a1afa7..a62f933693 100644 --- a/docs/react-native-core/Reference/DytePlugin.md +++ b/docs/react-native-core/Reference/DytePlugin.md @@ -1,6 +1,6 @@ --- sidebar_position: 12 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DytePluginMap.md b/docs/react-native-core/Reference/DytePluginMap.md index 9e30899cb4..8160c6fe99 100644 --- a/docs/react-native-core/Reference/DytePluginMap.md +++ b/docs/react-native-core/Reference/DytePluginMap.md @@ -1,6 +1,6 @@ --- sidebar_position: 11 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DytePlugins.md b/docs/react-native-core/Reference/DytePlugins.md index 7c17d44585..d721df9c91 100644 --- a/docs/react-native-core/Reference/DytePlugins.md +++ b/docs/react-native-core/Reference/DytePlugins.md @@ -1,6 +1,6 @@ --- sidebar_position: 10 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DytePolls.md b/docs/react-native-core/Reference/DytePolls.md index f4d76cdc63..28b48f60e5 100644 --- a/docs/react-native-core/Reference/DytePolls.md +++ b/docs/react-native-core/Reference/DytePolls.md @@ -1,6 +1,6 @@ --- sidebar_position: 9 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DyteRecording.md b/docs/react-native-core/Reference/DyteRecording.md index 52c2450c12..b236074cad 100644 --- a/docs/react-native-core/Reference/DyteRecording.md +++ b/docs/react-native-core/Reference/DyteRecording.md @@ -1,6 +1,6 @@ --- sidebar_position: 15 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DyteRemote.md b/docs/react-native-core/Reference/DyteRemote.md index 1122007cba..68ff951f77 100644 --- a/docs/react-native-core/Reference/DyteRemote.md +++ b/docs/react-native-core/Reference/DyteRemote.md @@ -1,6 +1,6 @@ --- sidebar_position: 14 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-native-core/Reference/DyteSelf.md b/docs/react-native-core/Reference/DyteSelf.md index 435d9e99d4..9f52731781 100644 --- a/docs/react-native-core/Reference/DyteSelf.md +++ b/docs/react-native-core/Reference/DyteSelf.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- @@ -25,6 +25,7 @@ this module. * [.permissions](#module_DyteSelf+permissions) * [.suggestedTheme](#module_DyteSelf+suggestedTheme) * [.roomJoined](#module_DyteSelf+roomJoined) + * [.isPinned](#module_DyteSelf+isPinned) * [.addAudioMiddleware()](#module_DyteSelf+addAudioMiddleware) * [.removeAudioMiddleware()](#module_DyteSelf+removeAudioMiddleware) * [.addVideoMiddleware()](#module_DyteSelf+addVideoMiddleware) @@ -45,7 +46,7 @@ this module. * [.getSpeakerDevices()](#module_DyteSelf+getSpeakerDevices) * [.getDeviceById(deviceId, kind)](#module_DyteSelf+getDeviceById) * [.getAllDevices()](#module_DyteSelf+getAllDevices) - * [.pinned()](#module_DyteSelf+pinned) + * [.setIsPinned()](#module_DyteSelf+setIsPinned) * [.pin()](#module_DyteSelf+pin) * [.unpin()](#module_DyteSelf+unpin) * [.setDevice(device, preview)](#module_DyteSelf+setDevice) @@ -125,6 +126,12 @@ Returns suggested theme for the meeting. ### meeting.self.roomJoined Returns true if the local participant has joined the meeting. +**Kind**: instance property of [DyteSelf](#module_DyteSelf) + + +### meeting.self.isPinned +Returns true if the current user is pinned. + **Kind**: instance property of [DyteSelf](#module_DyteSelf) @@ -283,9 +290,9 @@ Returns the local participant's device, indexed by ID and kind. Returns all media devices accessible by the local participant. **Kind**: instance method of [DyteSelf](#module_DyteSelf) - + -### meeting.self.pinned() +### meeting.self.setIsPinned() **Kind**: instance method of [DyteSelf](#module_DyteSelf) diff --git a/docs/react-native-core/Reference/DyteThemePreset.md b/docs/react-native-core/Reference/DyteThemePreset.md index a1d80c176e..4dfbb2f4ff 100644 --- a/docs/react-native-core/Reference/DyteThemePreset.md +++ b/docs/react-native-core/Reference/DyteThemePreset.md @@ -1,6 +1,6 @@ --- sidebar_position: 13 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DyteChat.md b/docs/react-web-core/Reference/DyteChat.md index 3f8c348cd0..37e7061755 100644 --- a/docs/react-web-core/Reference/DyteChat.md +++ b/docs/react-web-core/Reference/DyteChat.md @@ -1,6 +1,6 @@ --- sidebar_position: 8 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DyteClient.md b/docs/react-web-core/Reference/DyteClient.md index 4eb06dcf2b..0638fdc650 100644 --- a/docs/react-web-core/Reference/DyteClient.md +++ b/docs/react-web-core/Reference/DyteClient.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DyteMeta.md b/docs/react-web-core/Reference/DyteMeta.md index d9ded826a7..c76444330a 100644 --- a/docs/react-web-core/Reference/DyteMeta.md +++ b/docs/react-web-core/Reference/DyteMeta.md @@ -1,6 +1,6 @@ --- sidebar_position: 7 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- @@ -11,16 +11,22 @@ This consists of the metadata of the meeting, such as the room name and the titl * [DyteMeta](#module_DyteMeta) - * [.roomName](#module_DyteMeta+roomName) - * [.joined](#module_DyteMeta+joined) * [.roomType](#module_DyteMeta+roomType) - * [.meetingTitle](#module_DyteMeta+meetingTitle) * [.meetingStartedTimestamp](#module_DyteMeta+meetingStartedTimestamp) + * [.joined](#module_DyteMeta+joined) + * [.roomName](#module_DyteMeta+roomName) + * [.meetingTitle](#module_DyteMeta+meetingTitle) - + -### meeting.meta.roomName -The room name of the meeting. +### meeting.meta.roomType +Indicates the meeting is a group-call or a webinar. + +**Kind**: instance property of [DyteMeta](#module_DyteMeta) + + +### meeting.meta.meetingStartedTimestamp +The timestamp of the time when the meeting started. **Kind**: instance property of [DyteMeta](#module_DyteMeta) @@ -29,10 +35,10 @@ The room name of the meeting. This is set to true if the current user has joined the meeting. **Kind**: instance property of [DyteMeta](#module_DyteMeta) - + -### meeting.meta.roomType -Indicates the meeting is a group-call or a webinar. +### meeting.meta.roomName +The room name of the meeting. **Kind**: instance property of [DyteMeta](#module_DyteMeta) @@ -41,9 +47,3 @@ Indicates the meeting is a group-call or a webinar. The title of the meeting. **Kind**: instance property of [DyteMeta](#module_DyteMeta) - - -### meeting.meta.meetingStartedTimestamp -The timestamp of the time when the meeting started. - -**Kind**: instance property of [DyteMeta](#module_DyteMeta) diff --git a/docs/react-web-core/Reference/DyteParticipant.md b/docs/react-web-core/Reference/DyteParticipant.md index 572122e555..1901a99442 100644 --- a/docs/react-web-core/Reference/DyteParticipant.md +++ b/docs/react-web-core/Reference/DyteParticipant.md @@ -1,6 +1,6 @@ --- sidebar_position: 5 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- @@ -32,6 +32,10 @@ const participant4 = meeting.participants.active.toArray().filter((p) => p.name * [.audioEnabled](#module_DyteParticipant+audioEnabled) * [.screenShareEnabled](#module_DyteParticipant+screenShareEnabled) * [.supportsRemoteControl](#module_DyteParticipant+supportsRemoteControl) + * [.isPinned](#module_DyteParticipant+isPinned) + * [.pin()](#module_DyteParticipant+pin) + * [.unpin()](#module_DyteParticipant+unpin) + * [.setIsPinned()](#module_DyteParticipant+setIsPinned) @@ -112,3 +116,27 @@ This is true if the participant is screensharing. This is true if the dyte participant supports remote control. **Kind**: instance property of [DyteParticipant](#module_DyteParticipant) + + +### participant.isPinned +Returns true if the participant is pinned. + +**Kind**: instance property of [DyteParticipant](#module_DyteParticipant) + + +### participant.pin() +Returns `participant.id` if user has permission +to pin participants. + +**Kind**: instance method of [DyteParticipant](#module_DyteParticipant) + + +### participant.unpin() +Returns `participant.id` if user has permission +to unpin participants. + +**Kind**: instance method of [DyteParticipant](#module_DyteParticipant) + + +### participant.setIsPinned() +**Kind**: instance method of [DyteParticipant](#module_DyteParticipant) diff --git a/docs/react-web-core/Reference/DyteParticipantMap.md b/docs/react-web-core/Reference/DyteParticipantMap.md index 6e0cb6c23c..9b9706711a 100644 --- a/docs/react-web-core/Reference/DyteParticipantMap.md +++ b/docs/react-web-core/Reference/DyteParticipantMap.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DyteParticipants.md b/docs/react-web-core/Reference/DyteParticipants.md index 927fde2fc1..58642c1a1d 100644 --- a/docs/react-web-core/Reference/DyteParticipants.md +++ b/docs/react-web-core/Reference/DyteParticipants.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- @@ -29,13 +29,12 @@ This module represents all the participants in the meeting. It consists of 4 map * [.rejectWaitingRoomRequest(id)](#module_DyteParticipants+rejectWaitingRoomRequest) * [.setViewMode(viewMode)](#module_DyteParticipants+setViewMode) * [.setPage(page)](#module_DyteParticipants+setPage) - * [.pin()](#module_DyteParticipants+pin) - * [.unpin()](#module_DyteParticipants+unpin) * [.disableAllAudio(allowUnMute)](#module_DyteParticipants+disableAllAudio) * [.disableAllVideo()](#module_DyteParticipants+disableAllVideo) * [.disableAudio(peerId)](#module_DyteParticipants+disableAudio) * [.disableVideo(peerId)](#module_DyteParticipants+disableVideo) * [.kickAll()](#module_DyteParticipants+kickAll) + * [.broadcastMessage()](#module_DyteParticipants+broadcastMessage) * [.kick(peerId)](#module_DyteParticipants+kick) @@ -157,20 +156,6 @@ Does not do anything in ACTIVE_GRID mode. | --- | --- | | page | The page number to be set. | - - -### meeting.participants.pin() -Returns `participant.id` if user has permission -to pin participants. - -**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) - - -### meeting.participants.unpin() -Returns `participant.id` if user has permission -to unpin participants. - -**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) ### meeting.participants.disableAllAudio(allowUnMute) @@ -215,6 +200,12 @@ Disables video for the given participant. ### meeting.participants.kickAll() Kicks all participants from the meeting. +**Kind**: instance method of [DyteParticipants](#module_DyteParticipants) + + +### meeting.participants.broadcastMessage() +Broadcasts the message to all participants including `self`. + **Kind**: instance method of [DyteParticipants](#module_DyteParticipants) diff --git a/docs/react-web-core/Reference/DytePermissionsPreset.md b/docs/react-web-core/Reference/DytePermissionsPreset.md index a94bc787ad..5119b69383 100644 --- a/docs/react-web-core/Reference/DytePermissionsPreset.md +++ b/docs/react-web-core/Reference/DytePermissionsPreset.md @@ -1,6 +1,6 @@ --- sidebar_position: 6 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DytePlugin.md b/docs/react-web-core/Reference/DytePlugin.md index 9513a1afa7..a62f933693 100644 --- a/docs/react-web-core/Reference/DytePlugin.md +++ b/docs/react-web-core/Reference/DytePlugin.md @@ -1,6 +1,6 @@ --- sidebar_position: 12 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DytePluginMap.md b/docs/react-web-core/Reference/DytePluginMap.md index 9e30899cb4..8160c6fe99 100644 --- a/docs/react-web-core/Reference/DytePluginMap.md +++ b/docs/react-web-core/Reference/DytePluginMap.md @@ -1,6 +1,6 @@ --- sidebar_position: 11 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DytePlugins.md b/docs/react-web-core/Reference/DytePlugins.md index 7c17d44585..d721df9c91 100644 --- a/docs/react-web-core/Reference/DytePlugins.md +++ b/docs/react-web-core/Reference/DytePlugins.md @@ -1,6 +1,6 @@ --- sidebar_position: 10 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DytePolls.md b/docs/react-web-core/Reference/DytePolls.md index f4d76cdc63..28b48f60e5 100644 --- a/docs/react-web-core/Reference/DytePolls.md +++ b/docs/react-web-core/Reference/DytePolls.md @@ -1,6 +1,6 @@ --- sidebar_position: 9 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DyteRecording.md b/docs/react-web-core/Reference/DyteRecording.md index 52c2450c12..b236074cad 100644 --- a/docs/react-web-core/Reference/DyteRecording.md +++ b/docs/react-web-core/Reference/DyteRecording.md @@ -1,6 +1,6 @@ --- sidebar_position: 15 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DyteRemote.md b/docs/react-web-core/Reference/DyteRemote.md index 1122007cba..68ff951f77 100644 --- a/docs/react-web-core/Reference/DyteRemote.md +++ b/docs/react-web-core/Reference/DyteRemote.md @@ -1,6 +1,6 @@ --- sidebar_position: 14 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/react-web-core/Reference/DyteSelf.md b/docs/react-web-core/Reference/DyteSelf.md index 435d9e99d4..9f52731781 100644 --- a/docs/react-web-core/Reference/DyteSelf.md +++ b/docs/react-web-core/Reference/DyteSelf.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- @@ -25,6 +25,7 @@ this module. * [.permissions](#module_DyteSelf+permissions) * [.suggestedTheme](#module_DyteSelf+suggestedTheme) * [.roomJoined](#module_DyteSelf+roomJoined) + * [.isPinned](#module_DyteSelf+isPinned) * [.addAudioMiddleware()](#module_DyteSelf+addAudioMiddleware) * [.removeAudioMiddleware()](#module_DyteSelf+removeAudioMiddleware) * [.addVideoMiddleware()](#module_DyteSelf+addVideoMiddleware) @@ -45,7 +46,7 @@ this module. * [.getSpeakerDevices()](#module_DyteSelf+getSpeakerDevices) * [.getDeviceById(deviceId, kind)](#module_DyteSelf+getDeviceById) * [.getAllDevices()](#module_DyteSelf+getAllDevices) - * [.pinned()](#module_DyteSelf+pinned) + * [.setIsPinned()](#module_DyteSelf+setIsPinned) * [.pin()](#module_DyteSelf+pin) * [.unpin()](#module_DyteSelf+unpin) * [.setDevice(device, preview)](#module_DyteSelf+setDevice) @@ -125,6 +126,12 @@ Returns suggested theme for the meeting. ### meeting.self.roomJoined Returns true if the local participant has joined the meeting. +**Kind**: instance property of [DyteSelf](#module_DyteSelf) + + +### meeting.self.isPinned +Returns true if the current user is pinned. + **Kind**: instance property of [DyteSelf](#module_DyteSelf) @@ -283,9 +290,9 @@ Returns the local participant's device, indexed by ID and kind. Returns all media devices accessible by the local participant. **Kind**: instance method of [DyteSelf](#module_DyteSelf) - + -### meeting.self.pinned() +### meeting.self.setIsPinned() **Kind**: instance method of [DyteSelf](#module_DyteSelf) diff --git a/docs/react-web-core/Reference/DyteThemePreset.md b/docs/react-web-core/Reference/DyteThemePreset.md index a1d80c176e..4dfbb2f4ff 100644 --- a/docs/react-web-core/Reference/DyteThemePreset.md +++ b/docs/react-web-core/Reference/DyteThemePreset.md @@ -1,6 +1,6 @@ --- sidebar_position: 13 -web_core_version: 0.24.0 +web_core_version: 0.26.0 --- diff --git a/docs/web-core/02-installation.mdx b/docs/web-core/01-installation.mdx similarity index 93% rename from docs/web-core/02-installation.mdx rename to docs/web-core/01-installation.mdx index 5b1b985f19..8a0d0b7aae 100644 --- a/docs/web-core/02-installation.mdx +++ b/docs/web-core/01-installation.mdx @@ -40,7 +40,7 @@ yarn add @dytesdk/web-core Add the following script tag in the head of your HTML file. ```html -