timeout reason added (#713)

Author: Brazol

docusaurus/docs/Flutter/05-advanced/02-ringing.mdx

@@ -138,7 +138,7 @@ void _onCallDecline(ActionCallDecline event) async {
   final callToReject = call.getDataOrNull();
   if (callToReject == null) return;
 
-  final result = await callToReject.reject();
+  final result = await callToReject.reject(reason: CallRejectReason.decline());
   if (result is Failure) {
     debugPrint('Error rejecting call: ${result.error}');
   }

dogfooding/lib/app/app_content.dart

@@ -254,7 +254,9 @@ class _StreamDogFoodingAppContentState
     final callToReject = call.getDataOrNull();
     if (callToReject == null) return;
 
-    final result = await callToReject.reject();
+    final result = await callToReject.reject(
+      reason: CallRejectReason.decline(),
+    );
     if (result is Failure) {
       debugPrint('Error rejecting call: ${result.error}');
     }

dogfooding/lib/screens/call_screen.dart

@@ -135,7 +135,7 @@ class _CallScreenState extends State<CallScreen> {
           call: widget.call,
           callConnectOptions: widget.connectOptions,
           onCancelCallTap: () async {
-            await widget.call.reject();
+            await widget.call.reject(reason: CallRejectReason.cancel());
             await widget.call.leave();
           },
           callContentBuilder: (

packages/stream_video/lib/src/call/call.dart

@@ -414,14 +414,14 @@ class Call {
 
     final outgoingCall = _getOutgoingCall();
     if (outgoingCall?.callCid != callCid) {
-      await outgoingCall?.reject(reason: 'cancel');
+      await outgoingCall?.reject(reason: CallRejectReason.cancel());
       await outgoingCall?.leave();
       await _setOutgoingCall(null);
     }
 
     final activeCall = _getActiveCall();
     if (activeCall?.callCid != callCid) {
-      await activeCall?.reject(reason: 'cancel');
+      await activeCall?.reject(reason: CallRejectReason.cancel());
       await activeCall?.leave();
       await _setActiveCall(null);
     }
@@ -433,7 +433,7 @@ class Call {
     return result;
   }
 
-  Future<Result<None>> reject({String? reason}) async {
+  Future<Result<None>> reject({CallRejectReason? reason}) async {
     final state = this.state.value;
     _logger.i(() => '[reject] ${_status.value}; state: $state');
     final status = state.status;
@@ -442,8 +442,10 @@ class Call {
       _logger.w(() => '[rejectCall] rejected (invalid status): $status');
       return Result.error('invalid status: $status');
     }
-    final result =
-        await _coordinatorClient.rejectCall(cid: state.callCid, reason: reason);
+    final result = await _coordinatorClient.rejectCall(
+      cid: state.callCid,
+      reason: reason?.value,
+    );
     if (result is Success<None>) {
       _stateManager.lifecycleCallRejected();
     }
@@ -582,7 +584,7 @@ class Call {
     if (result.isFailure) {
       _logger.e(() => '[join] waiting failed: $result');
 
-      await reject();
+      await reject(reason: CallRejectReason.timeout());
       _stateManager.lifecycleCallTimeout();
 
       return result;

packages/stream_video/lib/src/call/call_reject_reason.dart

@@ -0,0 +1,26 @@
+import 'package:equatable/equatable.dart';
+
+/// Reason for rejecting a call.
+///
+/// busy - when the callee is busy and cannot accept the call
+/// decline - when the callee intentionally declines the call
+/// cancel - when the caller cancels the call
+/// timeout - when the call times out
+class CallRejectReason with EquatableMixin {
+  const CallRejectReason._(this.value);
+
+  factory CallRejectReason.decline() => const CallRejectReason._('decline');
+  factory CallRejectReason.cancel() => const CallRejectReason._('cancel');
+  factory CallRejectReason.busy() => const CallRejectReason._('busy');
+  factory CallRejectReason.timeout() => const CallRejectReason._('timeout');
+  factory CallRejectReason.custom(String customType) =>
+      CallRejectReason._(customType);
+
+  final String value;
+
+  @override
+  String toString() => value;
+
+  @override
+  List<Object?> get props => [value];
+}

packages/stream_video/lib/stream_video.dart

@@ -4,6 +4,7 @@ export 'open_api/video/coordinator/api.dart';
 export 'src/call/call.dart';
 export 'src/call/call_connect_options.dart';
 export 'src/call/call_events.dart';
+export 'src/call/call_reject_reason.dart';
 export 'src/call/call_ringing_state.dart';
 export 'src/call/call_type.dart';
 export 'src/call_state.dart';

packages/stream_video_flutter/example/lib/screen/home_screen.dart

@@ -96,11 +96,11 @@ class _HomeScreenState extends State<HomeScreen> {
           call: call,
           callConnectOptions: options,
           onDeclineCallTap: () async {
-            await call.reject(reason: 'decline');
+            await call.reject(reason: CallRejectReason.decline());
             await call.leave();
           },
           onCancelCallTap: () async {
-            await call.reject(reason: 'cancel');
+            await call.reject(reason: CallRejectReason.cancel());
             await call.leave();
           },
         ),

packages/stream_video_flutter/lib/src/call_screen/incoming_call/incoming_call_content.dart

@@ -151,7 +151,7 @@ class _StreamIncomingCallContentState extends State<StreamIncomingCallContent> {
     if (widget.onDeclineCallTap != null) {
       widget.onDeclineCallTap!();
     } else {
-      await widget.call.reject(reason: 'decline');
+      await widget.call.reject(reason: CallRejectReason.decline());
       await widget.call.leave();
     }
   }

packages/stream_video_flutter/lib/src/call_screen/outgoing_call/outgoing_call_content.dart

@@ -166,7 +166,7 @@ class _StreamOutgoingCallContentState extends State<StreamOutgoingCallContent> {
     if (widget.onCancelCallTap != null) {
       widget.onCancelCallTap!();
     } else {
-      await widget.call.reject(reason: 'cancel');
+      await widget.call.reject(reason: CallRejectReason.cancel());
       await widget.call.leave();
     }
   }