CometChatIncomingCall is an iOS UI Kit component that displays an incoming call screen with caller details and options to accept or decline voice and video calls.
The Incoming call is a Component that serves as a visual representation when the user receives an incoming call, such as a voice call or video call, providing options to answer or decline the call.
CometChatIncomingCall being a custom view controller, offers versatility in its integration. It can be seamlessly launched via button clicks or any user-triggered action, enhancing the overall user experience and facilitating smoother interactions within the application.
Swift
let cometChatIncomingCall = CometChatIncomingCall().set(call: call)cometChatIncomingCall.modalPresentationStyle = .fullScreenself.present(cometChatIncomingCall, animated: true)
If you are already using a navigation controller, you can use the pushViewController function instead of presenting the view controller.
Actions dictate how a component functions. They are divided into two types: Predefined and User-defined. You can override either type, allowing you to tailor the behavior of the component to fit your specific needs.
1. SetOnAcceptClick
The setOnAcceptClick action is typically triggered when the user clicks on the accept button, initiating a predefined action. However, by implementing the following code snippet, you can easily customize or override this default behavior to suit your specific requirements.
Swift
let cometChatIncomingCall = CometChatIncomingCall().set(onAcceptClick: { call, controller in//Perform Your Action})
2. SetOnCancelClick
The setOnCancelClick action is typically triggered when the user clicks on the reject button, initiating a predefined action. However, by implementing the following code snippet, you can easily customize or override this default behavior to suit your specific requirements.
Swift
let cometChatIncomingCall = CometChatIncomingCall().set(onCancelClick: { call, controller in //Perform Your Action})
3. OnError
You can customize this behavior by using the provided code snippet to override the On Error and improve error handling.
Swift
let incomingCallConfiguration = IncomingCallConfiguration().set(onError:{ error in//Perform Your Action})
Filters allow you to customize the data displayed in a list within a Component. You can filter the list based on your specific criteria, allowing for a more customized. Filters can be applied using RequestBuilders of Chat SDK.The IncomingCall component does not have any exposed filters.
Events are emitted by a Component. By using event you can extend existing functionality. Being global events, they can be applied in Multiple Locations and are capable of being Added or Removed.Events emitted by the Incoming Call component is as follows.
Event
Description
onIncomingCallAccepted
Triggers when the logged-in user accepts the incoming call.
onIncomingCallRejected
This event is triggered when the logged-in user rejects the incoming call.
onCallEnded
This event is triggered when the initiated call successfully ends.
Add Listener
// View controller from your project where you want to listen events.public class ViewController: UIViewController { public override func viewDidLoad() { super.viewDidLoad() // Subscribing for the listener to listen events from user module CometChatCallEvents.addListener("UNIQUE_ID", self as CometChatCallEventListener) }} // Listener events from user moduleextension ViewController: CometChatCallEventListener { func onIncomingCallAccepted(call: Call) { // Do Stuff } func onIncomingCallRejected(call: Call){ // Do Stuff } func onCallEnded(call: Call) { // Do Stuff }}
Emitting Group Events
//emit this when logged in user accepts the incoming callCometChatCallEvents.emitOnIncomingCallAccepted(call: Call)//emit this when logged in user rejects the incoming callCometChatCallEvents.emitOnIncomingCallRejected(call: Call)//emit this when logged in user cancels a callCometChatCallEvents.emitOnCallEnded(call: Call)
Remove Listener
View Controller
public override func viewWillDisappear(_ animated: Bool) { // Uncubscribing for the listener to listen events from user module CometChatCallEvents.removeListener("LISTENER_ID_USED_FOR_ADDING_THIS_LISTENER")}
To fit your app’s design requirements, you can customize the appearance of the conversation component. We provide exposed methods that allow you to modify the experience and behavior according to your specific needs.
Using Style you can customize the look and feel of the component in your app, These parameters typically control elements such as the color, size, shape, and fonts used within the component.
1. IncomingCall Style
You can customize the appearance of the IncomingCall Component by applying the IncomingCallStyle to it using the following code snippet.Global level styling
For advanced-level customization, you can set custom views to the component. This lets you tailor each aspect of the component to fit your exact needs and application aesthetics. You can create and define your views, layouts, and UI elements and then incorporate those into the component.
