​
Overview

CometChatCallLogs is a Widget that shows the list of Call Logs available. By default, names are shown for all listed users, along with their avatars if available.
Image
The CometChatCallLogs widget is composed of the following BaseWidgets:
WidgetsDescription
CometChatListBaseCometChatListBase is a container widget featuring a title, customizable background options, and a dedicated list widget for seamless integration within your application’s interface.
CometChatListItemThis widget displays data retrieved from a CallLog object on a card, presenting a title and subtitle.

​
Usage

​
Integration

CometChatCallLogs being a wrapper widget, 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. You can launch CometChatCallLogs 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 CometChatCallLogs
Navigator.push(context, MaterialPageRoute(builder: (context) => CometChatCallLogs()));
2. Embedding CometChatCallLogs as a Widget in the build Method
import 'package:cometchat_calls_uikit/cometchat_calls_uikit.dart';
import 'package:flutter/material.dart';

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

  @override
  State<CallLogsExample> createState() => _CallLogsExampleState();
}

class _CallLogsExampleState extends State<CallLogsExample> {

  @override
  Widget build(BuildContext context) {
    return const Scaffold(
      body: SafeArea(
        child: CometChatCallLogs(),
      ),
    );
  }
}

​
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. onItemClick
This method proves valuable when users seek to override the onItemClick functionality within CometChatCallLogs, empowering them with greater control and customization options. The onItemClick action doesn’t have a predefined behavior. You can override this action using the following code snippet. 
CometChatCallLogs(
  onItemClick: (callLog) {
    // TODO("Not yet implemented")
  },
)
2. OnError
You can customize this behavior by using the provided code snippet to override the OnError and improve error handling. 
CometChatCallLogs(
  onError: (e) {
    // TODO("Not yet implemented")
  },
)
3. onBack
You can customize this behavior by using the provided code snippet to override the onBack and improve error handling. 
CometChatCallLogs(
  onBack: () {
    // TODO("Not yet implemented")
  },
)
4. onInfoIconClick
You can customize this behavior by using the provided code snippet to override the onInfoIconClick and improve error handling. 
CometChatCallLogs(
  onInfoIconClick: (CallLog callLog) {
    // 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.
1. CallLogRequestBuilder
The CallLogRequestBuilder enables you to filter and customize the call list based on available parameters in CallLogRequestBuilder. This feature allows you to create more specific and targeted queries during the call. The following are the parameters available in CallLogRequestBuilder Example In the example below, we are applying a filter based on the limit and have a call recording. 
CometChatCallLogs(
  callLogsRequestBuilder: CallLogRequestBuilder()
    ..limit = 10
    ..hasRecording = true,
)
List of properties exposed by CallLogRequestBuilder
PropertyDescriptionCode
Auth TokenSets the authentication token.authToken: String?
Call CategorySets the category of the call.callCategory: String?
Call DirectionSets the direction of the call.callDirection: String?
Call StatusSets the status of the call.callStatus: String?
Call TypeSets the type of the call.callType: String?
GuidSets the unique ID of the group involved in the call.guid: String?
Has RecordingIndicates if the call has a recording.hasRecording: bool
LimitSets the maximum number of call logs to return per request.limit: int
UidSets the unique ID of the user involved in the call.uid: String?

​
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. The CometChatCallLogs widget does not have any exposed events.

​
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. CallLogs Style
You can customize the appearance of the CometChatCallLogs Widget by applying the CallLogsStyle to it using the following code snippet. 
CometChatCallLogs(
  callLogsStyle: CallLogsStyle(
      background: Color(0xFFE4EBF5),
      titleStyle: TextStyle(color: Colors.red),
  ),
)
Image
List of properties exposed by CallLogStyle
PropertyDescriptionCode
Back Icon TintSets the color for the back icon.backIconTint: Color?
BackgroundSets the background color.background: Color?
BorderSets the border style.border: BoxBorder?
Border RadiusSets the border radius.borderRadius: double?
Call Status Icon TintSets the color for the call status icon.callStatusIconTint: Color?
Empty Text StyleSets the text style for empty state text.emptyTextStyle: TextStyle?
Error Text StyleSets the text style for error messages.errorTextStyle: TextStyle?
GradientSets the gradient background.gradient: Gradient?
HeightSets the height of the call logs style.height: double?
Info Icon TintSets the color for the info icon.infoIconTint: Color?
Loading Icon TintSets the color for the loading icon.loadingIconTint: Color?
Sub Title StyleSets the text style for subtitles.subTitleStyle: TextStyle?
Tail Title StyleSets the text style for tail titles.tailTitleStyle: TextStyle?
Title StyleSets the text style for titles.titleStyle: TextStyle?
WidthSets the width of the call logs style.width: double?
2. Avatar Styles
To apply customized styles to the Avatar widget in the CallLogs Widget, you can use the following code snippet. For further insights on Avatar Styles refer 
CometChatCallLogs(
  avatarStyle: AvatarStyle(
      border: Border.all(width: 5),
      borderRadius: 20,
      background: Colors.red
  ),
)
3. ListItem Styles
To apply customized styles to the ListItemStyle widget in the CallLogs Widget, you can use the following code snippet. For further insights on ListItemStyle Styles refer 
CometChatCallLogs(
  listItemStyle: ListItemStyle(
      background: Color(0xFFE4EBF5),
      borderRadius: 20,
      border: Border.all(width: 2),
      margin: EdgeInsets.only(top: 10),
      padding: EdgeInsets.only(left: 10)
  ),
)

​
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. 
CometChatCallLogs(
  title: "Your Title",
  backButton: Icon(Icons.add_alert, color: Color(0xFF6851D6)),
)
Image
Below is a list of customizations along with corresponding code snippets
PropertyDescriptionCode
Back ButtonA widget for the back button.backButton: Widget?
Call Logs Request BuilderBuilder for creating call log requests.callLogsRequestBuilder: CallLogRequestBuilder?
Date PatternFormat pattern for date display.datePattern: String?
Date Separator PatternFormat pattern for date separator.dateSeparatorPattern: String?
Empty State TextText to display when there are no call logs.emptyStateText: String?
Error State TextText to display when there is an error.errorStateText: String?
Hide SeparatorWhether to hide the separator between call logs.hideSeparator: bool
Incoming Audio Call IconIcon for incoming audio calls.incomingAudioCallIcon: Icon?
Incoming Video Call IconIcon for incoming video calls.incomingVideoCallIcon: Icon?
Info Icon UrlURL for the info icon.infoIconUrl: String?
Loading Icon UrlURL for the loading icon.loadingIconUrl: String?
Missed Audio Call IconIcon for missed audio calls.missedAudioCallIcon: Icon?
Missed Video Call IconIcon for missed video calls.missedVideoCallIcon: Icon?
Outgoing Audio Call IconIcon for outgoing audio calls.outgoingAudioCallIcon: Icon?
Outgoing Video Call IconIcon for outgoing video calls.outgoingVideoCallIcon: Icon?
Show Back ButtonWhether to show the back button.showBackButton: bool?
TitleTitle for the call logs section.title: String?

​
Advanced

For advanced-level customization, you can set custom widgets 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 widgets, layouts, and UI elements and then incorporate those into the widget.

​
ListItemView

With this property, you can assign a custom ListItem to the Call Logs Widget. Example Here is the complete example for reference: 
CometChatCallLogs(
  listItemView: (CallLog callLog, BuildContext context) {
    return Container(
      margin: const EdgeInsets.only(top: 10),
      width: MediaQuery.of(context).size.width/1.2,
      decoration: BoxDecoration(
        color: Color(0xFFE4EBF5),
        borderRadius: BorderRadius.circular(20),
        border: Border.all(width: 2)
      ),
      padding: const EdgeInsets.all(10),
      child: Row(
        crossAxisAlignment: CrossAxisAlignment.center,
        children: [
          CometChatAvatar(
            name: callLog.participants![0].name!,
          ),
          Column(
            children: [
              Text(callLog.participants![0].name!),
              Text("Duration: ${callLog.totalDurationInMinutes} minutes"),
            ],
          )
        ],
      ),
    );
  },
)
Image

​
SubtitleView

You can customize the subtitle widget for each call logs item to meet your requirements Example Here is the complete example for reference: 
CometChatCallLogs(
  subTitleView: (context, conversation) {
    return const Row(
      children: [
        Icon(Icons.call, color: Color(0xFF6851D6), size: 25,),
        SizedBox(width: 10),
        Icon(Icons.video_call, color: Color(0xFF6851D6), size: 25,),
      ],
    );
  },
)
Image

​
TailView

You can customize the tail widget for each call logs item to meet your requirements Example Here is the complete example for reference: 
CometChatCallLogs(
  tailView: (BuildContext context, CallLog callLog) {
    return SizedBox(
      width: 100,
      child: const Row(
        children: [
          Icon(Icons.call, color: Color(0xFF6851D6), size: 25,),
          SizedBox(width: 10),
          Icon(Icons.video_call, color: Color(0xFF6851D6), size: 25,),
        ],
      ),
    ); // Replaced the placeholder with a custom widget.
  },
)
Image

​
LoadingStateView

You can set a custom loader widget using loadingStateView to match the loading widget of your app. Example Here is the complete example for reference: 
CometChatCallLogs(
  loadingStateView: (context) {
    return SizedBox(
      width: MediaQuery.of(context).size.width,
      child: const Center(
          child: CircularProgressIndicator()
      ),
    );
  },
)
Image

​
EmptyStateView

You can set a custom EmptyStateView using emptyStateView to match the empty widget of your app. Example Here is the complete example for reference: 
CometChatCallLogs(
  emptyStateView: (context) {
    return SizedBox(
      width: MediaQuery.of(context).size.width,
      child: const Center(
          child: Column(
            crossAxisAlignment: CrossAxisAlignment.center,
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Spacer(),
              Icon(Icons.sms_failed_outlined, color: Colors.red, size: 100,),
              SizedBox(height: 20,),
              Text("Your Custom Message"),
              Spacer(),
            ],
          )
      ),
    );
  },
)
Image

​
ErrorStateView

You can set a custom ErrorStateView using errorStateView to match the error widget of your app. Example Here is the complete example for reference: 
CometChatCallLogs(
  errorStateView: (context) {
    return SizedBox(
      width: MediaQuery.of(context).size.width,
      child: const Center(
        child: Column(
          crossAxisAlignment: CrossAxisAlignment.center,
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Spacer(),
            Icon(Icons.error_outline, color: Colors.red, size: 100,),
            SizedBox(height: 20,),
            Text("Your Custom Error Message"),
            Spacer(),
          ],
        ),
      ),
    );
  },
)

​
Configurations

Configurations offer the ability to customize the properties of each widget within a Composite Widget. CometChatCallLogs has CometChatOutgoingCall widget. Hence, each of these widgets will have its individual `Configuration“.
  • Configurations expose properties that are available in its individual widgets.

​
Outgoing Call

You can customize the properties of the OutGoing Call widget by making use of the OutgoingCallConfiguration. You can accomplish this by employing the outgoingCallConfiguration props as demonstrated below: Example Here is the complete example for reference: 
CometChatCallLogs(
  outgoingCallConfiguration: OutgoingCallConfiguration(
    subtitle: "Outgoing Call",
    outgoingCallStyle: OutgoingCallStyle(
      background: Color(0xFFE4EBF5),
    )
  ),
)
Image
All exposed properties of OutgoingCallConfiguration can be found under OutGoing Call. Properties marked with the 🛑 symbol are not accessible within the Configuration Object.