Call Buttons - CometChat Docs

Overview

The CometChatCallButtons is a Widget provides users with the ability to make calls, access call-related functionalities, and control call settings. Clicking this button typically triggers the call to be placed to the desired recipient.

Android
iOS

Usage

Integration

You can launch CometChatCallButtons directly using Navigator.push, or you can define it as a widget within the build method of your State class.

1. Using Navigator to Launch `CometChatCallButtons`

Dart

Navigator.push(context, MaterialPageRoute(builder: (context) => CometChatCallButtons()));

2. Embedding `CometChatCallButtons` as a Widget in the build Method

Dart

import 'package:cometchat_calls_uikit/cometchat_calls_uikit.dart';
import 'package:flutter/material.dart';

class CallButtonsExample extends StatefulWidget {
  const CallButtonsExample({super.key});

  @override
  State<CallButtonsExample> createState() => _CallButtonsExampleState();
}

class _CallButtonsExampleState extends State<CallButtonsExample> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: SafeArea(
        child: Center(
          child: CometChatCallButtons()
        )
      ),
    );
  }
}

Actions

Actions dictate how a widget functions. They are divided into two types: Predefined and User-defined. You can override either type, allowing you to tailor the behavior of the widget to fit your specific needs.

1. onVoiceCallClick

The onVoiceCallClick action is usually invoked when a voice call is initiated, executing predefined actions. However, by utilizing the provided code snippet, you can effortlessly tailor or override this default behavior to suit your unique requirements.

Dart

CometChatCallButtons(
  onVoiceCallClick: (BuildContext buildContext, User? user, Group? group) {
    // TODO("Not yet implemented")
  },
)

2. onVideoCallClick

The onVideoCallClick action is typically triggered when a video call is initiated, executing default actions. However, with the provided code snippet, you have the flexibility to easily customize or override this default behavior according to your specific preferences or requirements.

Dart

CometChatCallButtons(
  onVideoCallClick: (BuildContext buildContext, User? user, Group? group) {
    // TODO("Not yet implemented")
  },
)

3. onError

You can customize this behavior by using the provided code snippet to override the onError and improve error handling.

Dart

CometChatCallButtons(
  onError: (e) {
    // TODO("Not yet implemented")
  },
)

Filters

Filters allow you to customize the data displayed in a list within a Widget. 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 CallButton widget does not have any exposed filters.

Events

Events are emitted by a Widget. 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 Call buttons widget are as follows.

Event	Description
ccCallAccepted	Triggers when the outgoing call is accepted.
ccCallRejected	Triggers when the outgoing call is rejected.

Dart

import 'package:cometchat_chat_uikit/cometchat_chat_uikit.dart';
import 'package:flutter/material.dart';

class YourScreen extends StatefulWidget {
  const YourScreen({super.key});

  @override
  State<YourScreen> createState() => _YourScreenState();
}

class _YourScreenState extends State<YourScreen> with CometChatCallEventListener {

  @override
  void initState() {
    super.initState();
    CometChatCallEvents.addCallEventsListener("unique_listener_ID", this); // Add the listener
  }

  @override
  void dispose(){
    super.dispose();
    CometChatCallEvents.removeCallEventsListener("unique_listener_ID"); // Remove the listener
  }

  @override
  void ccCallAccepted(Call call) {
    // TODO("Not yet implemented")
  }

  @override
  void ccCallRejected(Call call) {
    // TODO("Not yet implemented")
  }

  @override
  Widget build(BuildContext context) {
    return const Placeholder();
  }

}

Customization

To fit your app’s design requirements, you can customize the appearance of the conversation widget. We provide exposed methods that allow you to modify the experience and behavior according to your specific needs.

Style

Using Style you can customize the look and feel of the widget in your app, These parameters typically control elements such as the color, size, shape, and fonts used within the widget.

1. CallButtons Style

You can customize the appearance of the CometChatCallButtons Widget by applying the CallButtonsStyle to it using the following code snippet.

Dart

CometChatCallButtons(
  callButtonsStyle: CallButtonsStyle(
    background: Color(0xFFE4EBF5),
    voiceCallIconTint: Colors.green,
    videoCallIconTint: Colors.blue,
    border: Border.all(color: Colors.grey, width: 5),
    borderRadius: 50,
  ),
)

Android
iOS

List of properties exposed by CallButtonsStyle

Property	Description	Code
Background	Sets the background color of the call buttons style.	`background: Color?`
Border	Sets the border properties of the call buttons style.	`border: BoxBorder?`
Border Radius	Sets the border radius of the call buttons style.	`borderRadius: double?`
Gradient	Sets the gradient applied to the call buttons style.	`gradient: Gradient?`
Height	Sets the height of the call buttons style.	`height: double?`
Video Call Icon Tint	Sets the color for the video call icon.	`videoCallIconTint: Color?`
Voice Call Icon Tint	Sets the color for the voice call icon.	`voiceCallIconTint: Color?`
Width	Sets the width of the call buttons style.	`width: double?`

Functionality

These are a set of small functional customizations that allow you to fine-tune the overall experience of the widget. With these, you can change text, set custom icons, and toggle the visibility of UI elements. Example Here is the example for reference:

Dart

CometChatCallButtons(
  voiceCallIconText: "Voice Call",
  hideVideoCall: true,
)

Android
iOS

Below is a list of customizations along with corresponding code snippets

Property	Description	Code
Hide Video Call	Hides the video call button.	`hideVideoCall: bool?`
Hide Voice Call	Hides the voice call button.	`hideVoiceCall: bool?`
Video Call Icon	Sets the icon for the video call button.	`videoCallIcon: Icon?`
Video Call Icon Hover Text	Sets the hover text for the video call button.	`videoCallIconHoverText: String?`
Video Call Icon Text	Sets the text for the video call button.	`videoCallIconText: String?`
Voice Call Icon	Sets the icon for the voice call button.	`voiceCallIcon: Icon?`
Voice Call Icon Hover Text	Sets the hover text for the voice call button.	`voiceCallIconHoverText: String?`
Voice Call Icon Text	Sets the text for the voice call button.	`voiceCallIconText: String?`

Advanced

For advanced-level customization, you can set custom views to the widget. This lets you tailor each aspect of the widget 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 widget. The CometChatCallButtons widget does not provide additional functionalities beyond this level of customization.

​Overview

​Usage

​Integration

1. Using Navigator to Launch CometChatCallButtons

2. Embedding CometChatCallButtons as a Widget in the build Method

​Actions