Implement operation to clear local data created by the SDK (#6090)

* Refactor cache management.

* Refactor external storage management.

* Introduce ChatClient#clearCacheAndTemporaryFiles method.

* Update CHANGELOG.md.

* Update clean-up logic.

* Update clean-up logic.

* Fix remarks

* Fix remarks

* Fix remarks

* Solidify external storage filename matching.

Author: VelikovPetar

CHANGELOG.md

@@ -17,6 +17,7 @@
 ### ⬆️ Improved
 
 ### ✅ Added
+- Add `ChatClient.clearCacheAndTemporaryFiles(context: Context)` method for clearing cache and temporary files created by the SDK. [#6090](https://github.com/GetStream/stream-chat-android/pull/6090)
 
 ### ⚠️ Changed
 

stream-chat-android-client/api/stream-chat-android-client.api

@@ -25,6 +25,7 @@ public final class io/getstream/chat/android/client/ChatClient {
 	public final fun castPollVote (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public final fun channel (Ljava/lang/String;)Lio/getstream/chat/android/client/channel/ChannelClient;
 	public final fun channel (Ljava/lang/String;Ljava/lang/String;)Lio/getstream/chat/android/client/channel/ChannelClient;
+	public final fun clearCacheAndTemporaryFiles (Landroid/content/Context;)Lio/getstream/result/call/Call;
 	public final fun clearPersistence ()Lio/getstream/result/call/Call;
 	public final fun closePoll (Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public final fun connectAnonymousUser ()Lio/getstream/result/call/Call;

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/ChatClient.kt

@@ -107,6 +107,7 @@ import io.getstream.chat.android.client.helpers.AppSettingManager
 import io.getstream.chat.android.client.helpers.CallPostponeHelper
 import io.getstream.chat.android.client.interceptor.SendMessageInterceptor
 import io.getstream.chat.android.client.interceptor.message.internal.PrepareMessageLogicImpl
+import io.getstream.chat.android.client.internal.file.StreamFileManager
 import io.getstream.chat.android.client.logger.ChatLogLevel
 import io.getstream.chat.android.client.logger.ChatLoggerConfigImpl
 import io.getstream.chat.android.client.logger.ChatLoggerHandler
@@ -231,6 +232,7 @@ import io.getstream.result.call.retry.RetryPolicy
 import io.getstream.result.call.share
 import io.getstream.result.call.toUnitCall
 import io.getstream.result.call.withPrecondition
+import io.getstream.result.flatMap
 import io.getstream.result.flatMapSuspend
 import io.getstream.result.onErrorSuspend
 import kotlinx.coroutines.CoroutineScope
@@ -290,6 +292,7 @@ internal constructor(
     internal val messageReceiptManager: MessageReceiptManager,
 ) {
     private val logger by taggedLogger(TAG)
+    private val fileManager = StreamFileManager()
     private val waitConnection = MutableSharedFlow<Result<ConnectionData>>()
     public val clientState: ClientState = mutableClientState
 
@@ -1479,6 +1482,40 @@ internal constructor(
             Result.Success(Unit)
         }.doOnStart(clientScope) { setUserWithoutConnectingIfNeeded() }
 
+    /**
+     * Clears all cache and temporary files created by the Stream Chat SDK.
+     *
+     * This method removes:
+     * - All cached files from the default cache directory
+     * - All cached images from the image cache directory
+     * - All cached files during the upload/download process
+     * - All temporary files stored in external storage by the SDK (Photos and videos captured using the SDK)
+     *
+     * **Note**: This method does NOT clear database persistence. Use [clearPersistence] to clear
+     * database data, or call both methods if you need to clear all SDK data.
+     *
+     * **Note**: This method does NOT clear downloads made by the SDK to the file system. Those files are
+     * stored outside of the SDK's control and cannot be removed automatically.
+     *
+     * @param context The Android [Context] for accessing cache and external storage directories
+     * @return Executable async [Call] which performs the cleanup
+     */
+    @CheckResult
+    public fun clearCacheAndTemporaryFiles(context: Context): Call<Unit> =
+        CoroutineCall(clientScope) {
+            logger.d { "[clearCacheAndTemporaryFiles] Clearing all cache and temporary files" }
+            // Clear all cache directories
+            val cacheResult = fileManager.clearAllCache(context)
+            // Clear external (temporary) storage files - always run regardless of cache result
+            val externalStorageResult = fileManager.clearExternalStorage(context)
+            // Return the first failure if any, otherwise success
+            when {
+                cacheResult is Result.Failure -> cacheResult
+                externalStorageResult is Result.Failure -> externalStorageResult
+                else -> Result.Success(Unit)
+            }
+        }
+
     /**
      * Disconnect the current user, stop all observers and clear user data.
      * This method should only be used whenever the user logouts from the main app.