Skip to content

Commit 25e6373

Browse files
authored
docs: add RealtimeV2 migration guide link to deprecation message (#223)
* docs: add RealtimeV2 migration guide link to deprecation message * style: swift format
1 parent 4a11b64 commit 25e6373

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

Sources/Realtime/Presence.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ import Foundation
9494
*,
9595
deprecated,
9696
renamed: "PresenceV2",
97-
message: "Presence class is deprecated in favor of PresenceV2."
97+
message: "Presence class is deprecated in favor of PresenceV2. See migration guide: https://github.com/supabase-community/supabase-swift/blob/main/docs/migrations/RealtimeV2%20Migration%20Guide.md"
9898
)
9999
public final class Presence {
100100
// ----------------------------------------------------------------------

Sources/Realtime/RealtimeChannel.swift

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,11 @@ public enum RealtimeSubscribeStates {
139139
/// .receive("error") { payload in print("Failed ot join", payload) }
140140
/// .receive("timeout") { payload in print("Networking issue...", payload) }
141141
///
142-
142+
@available(
143+
*,
144+
deprecated,
145+
message: "Use new RealtimeChannelV2 class instead. See migration guide: https://github.com/supabase-community/supabase-swift/blob/main/docs/migrations/RealtimeV2%20Migration%20Guide.md"
146+
)
143147
public class RealtimeChannel {
144148
/// The topic of the RealtimeChannel. e.g. "rooms:friends"
145149
public let topic: String

Sources/Realtime/RealtimeClient.swift

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,11 @@ struct StateChangeCallbacks {
5858
/// The `RealtimeClient` constructor takes the mount point of the socket,
5959
/// the authentication params, as well as options that can be found in
6060
/// the Socket docs, such as configuring the heartbeat.
61-
@available(*, deprecated, message: "Use new RealtimeClientV2 class instead.")
61+
@available(
62+
*,
63+
deprecated,
64+
message: "Use new RealtimeClientV2 class instead. See migration guide: https://github.com/supabase-community/supabase-swift/blob/main/docs/migrations/RealtimeV2%20Migration%20Guide.md"
65+
)
6266
public class RealtimeClient: PhoenixTransportDelegate {
6367
// ----------------------------------------------------------------------
6468

0 commit comments

Comments
 (0)