Skip to content

Commit c6b92ef

Browse files
committed
feat: add RTK migration guide for iOS
1 parent dbfbf95 commit c6b92ef

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

docs/guides/realtimekit-migration/sdk-guide.mdx

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,19 @@ The Dyte SDKs are now in maintenance mode and will no longer receive feature upd
6565
| [`io.dyte:core`](https://central.sonatype.com/artifact/io.dyte/core) | [`com.cloudflare.realtimekit:core`](https://central.sonatype.com/artifact/com.cloudflare.realtimekit/core) |
6666
| [`io.dyte:uikit`](https://central.sonatype.com/artifact/io.dyte/uikit) | [`com.cloudflare.realtimekit:ui-android`](https://central.sonatype.com/artifact/com.cloudflare.realtimekit/ui-android) |
6767
</TabItem>
68+
<TabItem value="ios" label="iOS">
69+
The following table maps the deprecated Dyte SDKs to their new Cloudflare RealtimeKit equivalents for iOS:
70+
| Dyte SDK | RealtimeKit SDK |
71+
| -------------- | ----------------------------------------------------------------- |
72+
| `DyteiOSCore` | [`RealtimeKit`](https://github.com/dyte-in/RealtimeKitUI) |
73+
| `DyteUiKit` | [`RealtimeKitUI`](https://github.com/dyte-in/RealtimeKitCoreiOS) |
74+
75+
:::warning
76+
We have deprecated [Cocoapods](https://blog.cocoapods.org/CocoaPods-Specs-Repo/) support in favor of Swift Package Manager. Please migrate to continue using our SDKs.
77+
78+
Check out our quickstart guides for [`RealtimeKit`](https://docs.realtime.cloudflare.com/ios-core#step-1-install-the-sdk) and [`RealtimeKitUI`](https://docs.realtime.cloudflare.com/ios/quickstart#step-1-install-the-sdk) for detailed installation instructions.
79+
:::
80+
</TabItem>
6881
</Tabs>
6982

7083
## Migration Steps
@@ -740,4 +753,44 @@ The Dyte SDKs are now in maintenance mode and will no longer receive feature upd
740753
| `com.cloudflare.realtimekit.platform.RtkPluginFile` | `com.cloudflare.realtimekit.plugins.RtkPluginFile` |
741754

742755
</TabItem>
756+
757+
<TabItem value="ios" label="iOS">
758+
Migrating from Dyte to Cloudflare RealtimeKit is a straightforward process that mainly involves updating package names and renaming components and classes.
759+
760+
To manually migrate your project, follow these steps:
761+
762+
### 1. Update Package Imports
763+
764+
In your source code, replace all Dyte package import paths with their corresponding RealtimeKit equivalents:
765+
766+
| Find | Replace With |
767+
| ------------- | --------------- |
768+
| `DyteiOSCore` | `RealtimeKit` |
769+
| `DyteUiKit` | `RealtimeKitUI` |
770+
771+
### 2. Update Naming Conventions
772+
773+
RealtimeKit introduces new naming conventions. Generally, replace `Dyte` with `RealtimeKit`, `RTK`, or `Rtk`, depending on the context.
774+
775+
:::info Naming Convention Summary
776+
- **Core SDK Classes & Types**: Replace `Dyte` with `Rtk` (e.g., `DyteMeetingType``RtkMeetingType`)
777+
- **UI Kit Components & Types**: Replace `Dyte` with `Rtk` (e.g., `DyteControlBarButton``RtkControlBarButton`)
778+
:::
779+
780+
#### Core SDK Changes
781+
782+
Update your classes by replacing `Dyte` with `RealtimeKit` or `Rtk`. Here are some examples (not exhaustive):
783+
784+
| Find | Replace With |
785+
| ------------------------ | ------------------------ |
786+
| `DyteClient` | `RealtimeKitClient` |
787+
| `DyteSelfParticipant` | `RtkSelfParticipant` |
788+
| `DyteSelfEventsListener` | `RtkSelfEventListener` |
789+
790+
Constructor parameters such as `mobileClient` have also been renamed to `rtkClient`, among others.
791+
792+
#### UI Kit Changes
793+
794+
For all UI Kit components, types, and providers, replace `Dyte` with `Rtk` in their names.
795+
</TabItem>
743796
</Tabs>

0 commit comments

Comments
 (0)