ifix: add individuals public class documentation

docs/ios-core/reference/DyteChat.md

@@ -0,0 +1,212 @@
+---
+sidebar_position: 7
+web_core_version: 1.20.0
+---
+
+<!-- Auto Generated Below -->
+
+<a name="module_DyteChat"></a>
+
+This is the chat module, which can be used to send and receive messages from the meeting.
+
+- [DyteChat](#module_DyteChat)
+  - [.messages](#module_DyteChat+messages)
+  - [.channels](#module_DyteChat+channels)
+  - [.roomJoined](#module_DyteChat+roomJoined)
+  - [.pinned](#module_DyteChat+pinned)
+  - [.sendTextMessage(message)](#module_DyteChat+sendTextMessage)
+  - [.sendImageMessage(image)](#module_DyteChat+sendImageMessage)
+  - [.sendFileMessage(file)](#module_DyteChat+sendFileMessage)
+  - [.sendMessage(message, participantIds)](#module_DyteChat+sendMessage)
+  - [.getMessagesByUser(userId)](#module_DyteChat+getMessagesByUser)
+  - [.getMessagesByType(type)](#module_DyteChat+getMessagesByType)
+  - [.pin(id)](#module_DyteChat+pin)
+  - [.unpin(id)](#module_DyteChat+unpin)
+  - [.getMessages()](#module_DyteChat+getMessages)
+  - [.createChannel()](#module_DyteChat+createChannel)
+  - [.updateChannel()](#module_DyteChat+updateChannel)
+  - [.sendMessageToChannel(message, channelId)](#module_DyteChat+sendMessageToChannel)
+  - [.getChannelMembers()](#module_DyteChat+getChannelMembers)
+  - [.searchMessages()](#module_DyteChat+searchMessages)
+  - [.markLastReadMessage()](#module_DyteChat+markLastReadMessage)
+
+<a name="module_DyteChat+messages"></a>
+
+### meeting.chat.messages
+
+An array of chat messages.
+
+<a name="module_DyteChat+channels"></a>
+
+### meeting.chat.channels
+
+An Array of all available channels.
+
+<a name="module_DyteChat+roomJoined"></a>
+
+### meeting.chat.roomJoined
+
+Returns true if the local participant has joined the meeting.
+
+<a name="module_DyteChat+pinned"></a>
+
+### meeting.chat.pinned
+
+Returns an array of pinned messages.
+
+<a name="module_DyteChat+sendTextMessage"></a>
+
+### meeting.chat.sendTextMessage(message)
+
+Sends a chat text message to the room.
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param   | Description                                |
+| ------- | ------------------------------------------ |
+| message | The message that must be sent to the room. |
+
+<a name="module_DyteChat+sendImageMessage"></a>
+
+### meeting.chat.sendImageMessage(image)
+
+Sends an image message to the meeting.
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param | Description                   |
+| ----- | ----------------------------- |
+| image | The image that is to be sent. |
+
+<a name="module_DyteChat+sendFileMessage"></a>
+
+### meeting.chat.sendFileMessage(file)
+
+Sends a file to the meeting.
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param | Description    |
+| ----- | -------------- |
+| file  | A File object. |
+
+<a name="module_DyteChat+sendMessage"></a>
+
+### meeting.chat.sendMessage(message, participantIds)
+
+Sends a message to the meeting. This method can be used to send text, image,
+or file messages. The message type is determined by the key 'type' in `message`
+object.
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param          | Description                                              |
+| -------------- | -------------------------------------------------------- |
+| message        | An object including the type and content of the message. |
+| participantIds | An array including the userIds of the participants.      |
+
+<a name="module_DyteChat+getMessagesByUser"></a>
+
+### meeting.chat.getMessagesByUser(userId)
+
+Returns an array of messages sent by a specific userId.
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param  | Description                                    |
+| ------ | ---------------------------------------------- |
+| userId | The user id of the user that sent the message. |
+
+<a name="module_DyteChat+getMessagesByType"></a>
+
+### meeting.chat.getMessagesByType(type)
+
+Returns an array of 'text', 'image' or 'file' messages.
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param | Description                 |
+| ----- | --------------------------- |
+| type  | 'text', 'image', or 'file'. |
+
+<a name="module_DyteChat+pin"></a>
+
+### meeting.chat.pin(id)
+
+Pins a chat message
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param | Description                    |
+| ----- | ------------------------------ |
+| id    | ID of the message to be pinned |
+
+<a name="module_DyteChat+unpin"></a>
+
+### meeting.chat.unpin(id)
+
+Unpins a chat message
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param | Description                      |
+| ----- | -------------------------------- |
+| id    | ID of the message to be unpinned |
+
+<a name="module_DyteChat+getMessages"></a>
+
+### meeting.chat.getMessages()
+
+Gets chat messages in a paginated manner
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)  
+<a name="module_DyteChat+createChannel"></a>
+
+### meeting.chat.createChannel()
+
+Creates a channel with specified name and userIds as members
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)  
+<a name="module_DyteChat+updateChannel"></a>
+
+### meeting.chat.updateChannel()
+
+Updates the channel
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)  
+<a name="module_DyteChat+sendMessageToChannel"></a>
+
+### meeting.chat.sendMessageToChannel(message, channelId)
+
+Sends a message to a channel. This method can be used to send text, image,
+or file messages. The message type is determined by the key 'type' in `message`
+object.
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)
+
+| Param     | Description                                              |
+| --------- | -------------------------------------------------------- |
+| message   | An object including the type and content of the message. |
+| channelId | Id of the channel where you want to send the message.    |
+
+<a name="module_DyteChat+getChannelMembers"></a>
+
+### meeting.chat.getChannelMembers()
+
+returns a list of members added to the channel
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)  
+<a name="module_DyteChat+searchMessages"></a>
+
+### meeting.chat.searchMessages()
+
+search messages
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)  
+<a name="module_DyteChat+markLastReadMessage"></a>
+
+### meeting.chat.markLastReadMessage()
+
+marks last read message in a channel
+
+**Kind**: instance method of [<code>DyteChat</code>](#module_DyteChat)

docs/ios-core/reference/DyteClient.md

@@ -0,0 +1,151 @@
+---
+sidebar_position: 1
+web_core_version: 1.20.0
+---
+
+<!-- Auto Generated Below -->
+
+<a name="module_DyteClient"></a>
+
+The DyteClient class is the main class of the web core library.
+An object of the DyteClient class can be created using
+`await DyteClient.init({ ... })`. Typically, an object of `DyteClient` is
+named `meeting`.
+
+- [DyteClient](#module_DyteClient)
+  - _instance_
+    - [.participants](#module_DyteClient+participants)
+    - [.self](#module_DyteClient+self)
+    - [.meta](#module_DyteClient+meta)
+    - [.ai](#module_DyteClient+ai)
+    - [.plugins](#module_DyteClient+plugins)
+    - [.chat](#module_DyteClient+chat)
+    - [.polls](#module_DyteClient+polls)
+    - [.remote](#module_DyteClient+remote)
+    - [.connectedMeetings](#module_DyteClient+connectedMeetings)
+    - ~~[.joinRoom()](#module_DyteClient+joinRoom)~~
+    - ~~[.leaveRoom()](#module_DyteClient+leaveRoom)~~
+    - [.join()](#module_DyteClient+join)
+    - [.leave()](#module_DyteClient+leave)
+  - _static_
+    - [.init(options)](#module_DyteClient.init)
+  - _inner_
+    - [~networkCall](#module_DyteClient..networkCall)
+
+<a name="module_DyteClient+participants"></a>
+
+### meeting.participants
+
+The `participants` object consists of 4 maps of participants,
+`waitlisted`, `joined`, `active`, `pinned`. The maps are indexed by
+`peerId`s, and the values are the corresponding participant objects.
+
+<a name="module_DyteClient+self"></a>
+
+### meeting.self
+
+The `self` object can be used to manipulate audio and video settings,
+and other configurations for the local participant. This exposes methods
+to enable and disable media tracks, share the user's screen, etc.
+
+<a name="module_DyteClient+meta"></a>
+
+### meeting.meta
+
+The `room` object stores information about the current meeting, such
+as chat messages, polls, room name, etc.
+
+<a name="module_DyteClient+ai"></a>
+
+### meeting.ai
+
+The `ai` object is used to interface with Dyte's AI features.
+You can obtain the live meeting transcript and use other meeting AI
+features such as summary, and agenda using this object.
+
+<a name="module_DyteClient+plugins"></a>
+
+### meeting.plugins
+
+The `plugins` object stores information about the plugins available in
+the current meeting. It exposes methods to activate and deactivate them.
+
+<a name="module_DyteClient+chat"></a>
+
+### meeting.chat
+
+The chat object stores the chat messages that were sent in the meeting.
+This includes text messages, images, and files.
+
+<a name="module_DyteClient+polls"></a>
+
+### meeting.polls
+
+The polls object stores the polls that were initiated in the meeting.
+It exposes methods to create and vote on polls.
+
+<a name="module_DyteClient+remote"></a>
+
+### meeting.remote
+
+The remote object stores the remote control requests for the meeting.
+It exposes methods to request, accept and end the remote control.
+
+<a name="module_DyteClient+connectedMeetings"></a>
+
+### meeting.connectedMeetings
+
+The connectedMeetings object stores the connected meetings states.
+It exposes methods to create/read/update/delete methods for connected meetings.
+
+<a name="module_DyteClient+joinRoom"></a>
+
+### ~~meeting.joinRoom()~~
+
+**_Deprecated_**
+
+The `joinRoom()` method can be used to join the meeting. A `roomJoined` event
+is emitted on `self` when the room is joined successfully.
+
+**Kind**: instance method of [<code>DyteClient</code>](#module_DyteClient)  
+<a name="module_DyteClient+leaveRoom"></a>
+
+### ~~meeting.leaveRoom()~~
+
+**_Deprecated_**
+
+The `leaveRoom()` method can be used to leave a meeting.
+
+**Kind**: instance method of [<code>DyteClient</code>](#module_DyteClient)  
+<a name="module_DyteClient+join"></a>
+
+### meeting.join()
+
+The `join()` method can be used to join the meeting. A `roomJoined` event
+is emitted on `self` when the room is joined successfully.
+
+**Kind**: instance method of [<code>DyteClient</code>](#module_DyteClient)  
+<a name="module_DyteClient+leave"></a>
+
+### meeting.leave()
+
+The `leave()` method can be used to leave a meeting.
+
+**Kind**: instance method of [<code>DyteClient</code>](#module_DyteClient)  
+<a name="module_DyteClient.init"></a>
+
+### meeting.init(options)
+
+The `init` method can be used to instantiate the DyteClient class.
+This returns an instance of DyteClient, which can be used to perform
+actions on the meeting.
+
+**Kind**: static method of [<code>DyteClient</code>](#module_DyteClient)
+
+| Param             | Description                                                                   |
+| ----------------- | ----------------------------------------------------------------------------- |
+| options           | The options object.                                                           |
+| options.roomName  | The name of the room. (If you are using V2 Api's you don't need to send this) |
+| options.authToken | The authorization token received using the API.                               |
+| options.apiBase   | The base URL of the API.                                                      |
+| options.defaults  | The default audio and video settings.                                         |

docs/ios-core/reference/DyteLivestream.md

@@ -0,0 +1,30 @@
+---
+sidebar_position: 11
+web_core_version: 1.20.0
+---
+
+<!-- Auto Generated Below -->
+
+<a name="module_DyteLivestream"></a>
+
+The DyteLivestream module represents the state of the current livestream, and allows
+to start/stop live streams.
+
+- [DyteLivestream](#module_DyteLivestream)
+  - [.start()](#module_DyteLivestream+start)
+  - [.stop()](#module_DyteLivestream+stop)
+
+<a name="module_DyteLivestream+start"></a>
+
+### meeting.livestream.start()
+
+Starts livestreaming the meeting.
+
+**Kind**: instance method of [<code>DyteLivestream</code>](#module_DyteLivestream)  
+<a name="module_DyteLivestream+stop"></a>
+
+### meeting.livestream.stop()
+
+Stops livestreaming the meeting.
+
+**Kind**: instance method of [<code>DyteLivestream</code>](#module_DyteLivestream)