change: Change ServiceRequestResult class to sealed class for improved code readability

Author: Dev-hwang

documentation/models_documentation.md

@@ -125,12 +125,12 @@ The level of detail displayed in notifications on the lock screen.
 
 ### :chicken: ServiceRequestResult
 
-Result of service request.
+sealed class: Represents the result of a service request.
 
-| Property  | Description                         |
-|-----------|-------------------------------------|
-| `success` | Whether the request was successful. |
-| `error`   | Error when the request failed.      |
+| child                                 | Description                         |
+|---------------------------------------|-------------------------------------|
+| `ServiceRequestSuccess()`             | The service request was successful. |
+| `ServiceRequestFailure(Object error)` | The service request failed.         |
 
 ### :chicken: TaskStarter
 

lib/flutter_foreground_task.dart

@@ -127,9 +127,9 @@ class FlutterForegroundTask {
         await checkServiceStateChange(target: true);
       }
 
-      return ServiceRequestResult.success();
+      return const ServiceRequestSuccess();
     } catch (error) {
-      return ServiceRequestResult.error(error);
+      return ServiceRequestFailure(error: error);
     }
   }
 
@@ -142,9 +142,9 @@ class FlutterForegroundTask {
 
       await _platform.restartService();
 
-      return ServiceRequestResult.success();
+      return const ServiceRequestSuccess();
     } catch (error) {
-      return ServiceRequestResult.error(error);
+      return ServiceRequestFailure(error: error);
     }
   }
 
@@ -171,9 +171,9 @@ class FlutterForegroundTask {
         callback: callback,
       );
 
-      return ServiceRequestResult.success();
+      return const ServiceRequestSuccess();
     } catch (error) {
-      return ServiceRequestResult.error(error);
+      return ServiceRequestFailure(error: error);
     }
   }
 
@@ -190,9 +190,9 @@ class FlutterForegroundTask {
         await checkServiceStateChange(target: false);
       }
 
-      return ServiceRequestResult.success();
+      return const ServiceRequestSuccess();
     } catch (error) {
-      return ServiceRequestResult.error(error);
+      return ServiceRequestFailure(error: error);
     }
   }
 

lib/models/service_request_result.dart

@@ -1,19 +1,17 @@
-/// Result of service request.
-class ServiceRequestResult {
-  const ServiceRequestResult({
-    required this.success,
-    this.error,
-  });
-
-  /// Whether the request was successful.
-  final bool success;
+/// Represents the result of a service request.
+sealed class ServiceRequestResult {
+  const ServiceRequestResult();
+}
 
-  /// Error when the request failed.
-  final Object? error;
+/// The service request was successful.
+final class ServiceRequestSuccess extends ServiceRequestResult {
+  const ServiceRequestSuccess();
+}
 
-  factory ServiceRequestResult.success() =>
-      const ServiceRequestResult(success: true);
+/// The service request failed.
+final class ServiceRequestFailure extends ServiceRequestResult {
+  const ServiceRequestFailure({required this.error});
 
-  factory ServiceRequestResult.error(Object error) =>
-      ServiceRequestResult(success: false, error: error);
+  /// The error that occurred when the service request failed.
+  final Object error;
 }