Skip to content

Commit

Permalink
docs: add RealtimeV2 migration guide link to deprecation message (#223)
Browse files Browse the repository at this point in the history
* docs: add RealtimeV2 migration guide link to deprecation message

* style: swift format
  • Loading branch information
grdsdev authored Jan 22, 2024
1 parent 4a11b64 commit 25e6373
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Sources/Realtime/Presence.swift
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ import Foundation
*,
deprecated,
renamed: "PresenceV2",
message: "Presence class is deprecated in favor of PresenceV2."
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"
)
public final class Presence {
// ----------------------------------------------------------------------
Expand Down
6 changes: 5 additions & 1 deletion Sources/Realtime/RealtimeChannel.swift
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,11 @@ public enum RealtimeSubscribeStates {
/// .receive("error") { payload in print("Failed ot join", payload) }
/// .receive("timeout") { payload in print("Networking issue...", payload) }
///

@available(
*,
deprecated,
message: "Use new RealtimeChannelV2 class instead. See migration guide: https://github.com/supabase-community/supabase-swift/blob/main/docs/migrations/RealtimeV2%20Migration%20Guide.md"
)
public class RealtimeChannel {
/// The topic of the RealtimeChannel. e.g. "rooms:friends"
public let topic: String
Expand Down
6 changes: 5 additions & 1 deletion Sources/Realtime/RealtimeClient.swift
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,11 @@ struct StateChangeCallbacks {
/// The `RealtimeClient` constructor takes the mount point of the socket,
/// the authentication params, as well as options that can be found in
/// the Socket docs, such as configuring the heartbeat.
@available(*, deprecated, message: "Use new RealtimeClientV2 class instead.")
@available(
*,
deprecated,
message: "Use new RealtimeClientV2 class instead. See migration guide: https://github.com/supabase-community/supabase-swift/blob/main/docs/migrations/RealtimeV2%20Migration%20Guide.md"
)
public class RealtimeClient: PhoenixTransportDelegate {
// ----------------------------------------------------------------------

Expand Down
File renamed without changes.

0 comments on commit 25e6373

Please sign in to comment.