Merge pull request #349 from nielsvanvelzen/deprecate-ws1

Deprecate WebSocketApi
jellyfin · Jan 1, 2022 · c7100b2 · c7100b2
2 parents d7ac4f0 + 650ab1f
commit c7100b2
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/jellyfin-api/api/jellyfin-api.api b/jellyfin-api/api/jellyfin-api.api
@@ -192,7 +192,7 @@ public final class org/jellyfin/sdk/api/client/extensions/ApiClientExtensionsKt
 	public static final fun getYearsApi (Lorg/jellyfin/sdk/api/client/ApiClient;)Lorg/jellyfin/sdk/api/operations/YearsApi;
 }
 
-public final class org/jellyfin/sdk/api/client/extensions/CommonApiClientExtensionsKt {
+public final class org/jellyfin/sdk/api/client/extensions/JvmApiClientExtensionsKt {
 	public static final fun getWebSocket (Lorg/jellyfin/sdk/api/client/ApiClient;)Lorg/jellyfin/sdk/api/sockets/WebSocketApi;
 }
 

diff --git a/...yfin-api/src/jvmMain/kotlin/org/jellyfin/sdk/api/client/extensions/ApiClientExtensions.kt b/...yfin-api/src/jvmMain/kotlin/org/jellyfin/sdk/api/client/extensions/ApiClientExtensions.kt
@@ -1,9 +1,11 @@
-@file:JvmName("CommonApiClientExtensionsKt")
+@file:JvmName("JvmApiClientExtensionsKt")
 
 package org.jellyfin.sdk.api.client.extensions
 
 import org.jellyfin.sdk.api.client.ApiClient
 import org.jellyfin.sdk.api.sockets.WebSocketApi
 
+@Suppress("DeprecatedCallableAddReplaceWith")
+@Deprecated("Replaced with the new SocketApi. This class will be removed in the next SDK release.")
 public val ApiClient.webSocket: WebSocketApi
 	get() = getOrCreateApi { WebSocketApi(it) }
diff --git a/jellyfin-api/src/jvmMain/kotlin/org/jellyfin/sdk/api/sockets/SocketSubscription.kt b/jellyfin-api/src/jvmMain/kotlin/org/jellyfin/sdk/api/sockets/SocketSubscription.kt
@@ -5,6 +5,7 @@ import org.jellyfin.sdk.model.socket.IncomingSocketMessage
 /**
  * Subscription to the [WebSocketApi] that can be cancelled.
  */
+@Deprecated("Replaced with the new SocketApi. This class will be removed in the next SDK release.")
 public class SocketSubscription(
 	private val webSocketApi: WebSocketApi,
 	internal val callback: suspend (IncomingSocketMessage) -> Unit,

diff --git a/jellyfin-api/src/jvmMain/kotlin/org/jellyfin/sdk/api/sockets/WebSocketApi.kt b/jellyfin-api/src/jvmMain/kotlin/org/jellyfin/sdk/api/sockets/WebSocketApi.kt
@@ -121,6 +121,7 @@ private val logger = KotlinLogging.logger {}
  *
  * The user should verify the access token is correct as the server does not respond to bad authorization.
  */
+@Deprecated("Replaced with the new SocketApi. This class will be removed in the next SDK release.")
 public class WebSocketApi(
 	private val api: ApiClient,
 ) : Api {