Skip to main content
Version: v4

Call Logs

Overview​

CometChatCallLogs is a Component that shows the list of Call Log available . By default, names are shown for all listed users, along with their avatar if available.

Image

The Call Logs is comprised of the following components:

ComponentsDescription
CometChatLista reusable container component having title, search box, customisable background and a List View
cometchat-backdropThis element represents the background against which other elements are presented.
CometChatListItema component that renders data obtained from a Group object on a Tile having a title, subtitle, leading and trailing view
cometchat-dateThis Component used to show the date and time. You can also customize the appearance of this widget by modifying its logic.
cometchat-buttonThis component represents a button with optional icon and text.

Usage​

Integration​

import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  return <CometChatCallLogs />;
};

export default CallLogDemo;

Actions​

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. onItemClick​

OnItemClick is triggered when you click on a ListItem of the Call Logs component. By default it initiate a call to the participant associated with the respective ListItem. You can override this action using the following code snippet.

CallLogDemo.tsx
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const handleOnItemClick = () => {
    console.log("custom on item click");
  };
  return <CometChatCallLogs onItemClick={handleOnItemClick} />;
};

export default CallLogDemo;
2. onInfoClick​

onInfoClick is triggered when you click the Info button Icon of the Call Logs component. It does not have a default behavior. However, you can override its behavior using the following code snippet.

CallLogDemo.tsx
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const handleOnInfoClick = () => {
    console.log("custom on info click");
  };
  return <CometChatCallLogs onInfoClick={handleOnInfoClick} />;
};

export default CallLogDemo;
3. onError​

This action doesn't change the behavior of the component but rather listens for any errors that occur in the Call Logs component.

CallLogDemo.tsx
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const handleOnError = () => {
    console.log("your custom on error actions");
  };
  return <CometChatCallLogs onError={handleOnError} />;
};

export default CallLogDemo;

Filters​

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.

1. CallLogRequestBuilder​

The CallLogRequestBuilder enables you to filter and customize the Call Log based on available parameters in CallLogRequestBuilder. This feature allows you to create more specific and targeted queries when fetching the call logs. The following are the parameters available in CallLogRequestBuilder

MethodsTypeDescription
setLimitnumberSpecifies the number of call logs to fetch.
setCallTypeStringSets the type of calls to fetch (call or meet).
setCallStatuscallStatusSets the status of calls to fetch (initiated, ongoing, etc.)
setHasRecordingbooleanSets whether to fetch calls that have recordings.
setCallCategorystringSets the category of calls to fetch (call or meet).
setCallDirectionstringSets the direction of calls to fetch (incoming or outgoing)
setUidstringSets the UID of the user whose call logs to fetch.
setGuidstringSets the GUID of the user whose call logs to fetch.
setAuthTokenstringSets the Auth token of the logged-in user.

Example

In the example below, we're filtering Call Logs to show only canceled calls and setting the limit to five.

CallLogDemo.tsx
import { CallLogRequestBuilder } from "@cometchat/calls-sdk-javascript";
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  return (
    <CometChatCallLogs
      callLogRequestBuilder={new CallLogRequestBuilder()
        .setAuthToken("authtoken")
        .setLimit(5)
        .setCallStatus("cancelled")}
    />
  );
};

export default CallLogDemo;

Events​

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.

The list of events emitted by the Call Logs component is as follows.

EventDescription
ccMessageSentThis event is triggered when the sent message is in transit and also when it is received by the receiver.
const ccMessageSent = CometChatMessageEvents.ccMessageSent.subscribe(() => {
  //Your Code
});
ccMessageSent?.unsubscribe();

Customization​

To fit your app's design requirements, you can customize the appearance of the Call Logs component. 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 component in your app, These parameters typically control elements such as the color, size, shape, and fonts used within the component.

1. CallLogs Style​

To customize the appearance, you can assign a CallLogsStyle object to the Call Logs component.

Example

In this example, we are employing the callLogsStyle.

CallLogDemo.tsx
import { CometChatCallLogs, CallLogsStyle } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const callLogsStyle = new CallLogsStyle({
    background: "#dac6f5",
    titleColor: "#000000",
    dateTextColor: "#dac6f5",
  });
  return <CometChatCallLogs callLogsStyle={callLogsStyle} />;
};

export default CallLogDemo;
Image

The following properties are exposed by CallLogsStyle:

PropertyDescriptionCode
borderUsed to set borderborder?: string,
borderRadiusUsed to set border radiusborderRadius?: string;
backgroundUsed to set background colourbackground?: string;
heightUsed to set heightheight?: string;
widthUsed to set widthwidth?: string;
titleFontUsed to set title fonttitleFont?: string,
titleColorUsed to set title colortitleColor?: string;
emptyStateTextColorUsed to set empty state text coloremptyStateTextColor?: string;
emptyStateTextFontUsed to set empty state text fontemptyStateTextFont?: string;
errorStateTextColorUsed to set error state text colorerrorStateTextColor?: string;
errorStateTextFontUsed to set error state text fonterrorStateTextFont?: string;
loadingIconTintUsed to set loading icon tintloadingIconTint?: string;
infoIconTintUsed to set info icon tintinfoIconTint?: string;
missedCallIconTintUsed to set missed call icon tintmissedCallIconTint?: string;
outgoingCallIconTintUsed to set outgoing call icon tintoutgoingCallIconTint?: string;
incomingCallIconTintUsed to set incoming call icon tintincomingCallIconTint?: string;
callStatusTextFontUsed to set call status text fontcallStatusTextFont?: string;
callStatusTextColorUsed to set call status text colorcallStatusTextColor?: string;
dateTextFontUsed to set date text fontdateTextFont?: string;
dateTextColorUsed to set date text colordateTextColor?: string;
dateSeparatorTextFontUsed to set date separator text fontdateSeparatorTextFont?: string;
dateSeparatorTextColorUsed to set date separator text colordateSeparatorTextColor?: string;
2. Avatar Style​

If you want to apply customized styles to the Avatar component within the Call Logs Component, you can use the following code snippet. For more information you can refer Avatar Styles.

CallLogDemo.tsx
import { CometChatCallLogs, AvatarStyle } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const avatarStyle = new AvatarStyle({
    backgroundColor: "#cdc2ff",
    border: "2px solid #6745ff",
    borderRadius: "10px",
    outerViewBorderColor: "#ca45ff",
    outerViewBorderRadius: "5px",
    nameTextColor: "#4554ff",
  });
  return <CometChatCallLogs avatarStyle={avatarStyle} />;
};

export default CallLogDemo;
3. ListItem Style​

If you want to apply customized styles to the ListItemStyle component within the Call Logs Component, you can use the following code snippet. For more information, you can refer ListItem Styles.

CallLogDemo.tsx
import { CometChatCallLogs, ListItemStyle } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const listItemStyle = new ListItemStyle({
    width: "100%",
    height: "100%",
    border: "2px solid #cdc2ff",
  });
  return <CometChatCallLogs listItemStyle={listItemStyle} />;
};

export default CallLogDemo;

Functionality​

These are a set of small functional customizations that allow you to fine-tune the overall experience of the component. With these, you can change text, set custom icons, and toggle the visibility of UI elements.

Here is a code snippet demonstrating how you can customize the functionality of the Call Logs component.

CallLogDemo.tsx
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  return (
    <CometChatCallLogs
      title="Your Custom Title"
      datePattern={DatePatterns.DayDateTime}
      hideSeparator={false}
    />
  );
};

export default CallLogDemo;

Default:

Image

Custom:

Image

Below is a list of customizations along with corresponding code snippets

PropertyDescriptionCode
titleUsed to set custom titletitle='Your Custom Title'
emptyStateTextUsed to set custom empty state textemptyStateText='Your Custom Empty State Text'
errorStateTextUsed to set custom error state texterrorStateText='Your Custom Error State Text'
titleAlignmentUsed to set custom title alignmenttitleAlignment={TitleAlignment.center}
datePatternUsed to set custom date patterndatePattern={DatePatterns.DayDateTime}
dateSeparatorPatternUsed to set custom date separator patterndateSeparatorPattern={DatePatterns.DayDateTime}
infoIconUrlUsed to set custom info iconinfoIconUrl='Custom Info Icon URL'
incomingAudioCallIconUrlUsed to set custom incoming audio call iconincomingAudioCallIconUrl='Custom Incoming Audio Call Icon'
missedAudioCallIconUrlUsed to set custom missed audio call iconmissedAudioCallIconUrl='Custom Missed Audio Call Icon'
missedVideoCallIconUrlUsed to set custom missed video call iconmissedVideoCallIconUrl='Custom Missed Video Call Icon'
incomingVideoCallIconUrlUsed to set custom incoming video call iconincomingVideoCallIconUrl='Custom Incoming Video Call Icon'
outgoingAudioCallIconUrlUsed to set custom outgoing audio call iconoutgoingAudioCallIconUrl='Custom Outgoing Audio Call Icon'
outgoingVideoCallIconUrlUsed to set custom outgoing video call iconoutgoingVideoCallIconUrl='Custom Outgoing Video Call Icon'
loadingIconURLUsed to set custom loading iconloadingIconURL='Custom Loading Icon'
hideSeparatorOption to hide separatorhideSeparator={false}
activeCallUsed to set active Call that is currently selectedactiveCall={call}

Advanced​

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.

ListItemView​

With this property, you can assign a custom ListItem to the Call Logs Component.

listItemView = { getListItemView };

Example

Default:

Image

Custom:

Image
CallLogDemo.tsx
import { CallLog } from "@cometchat/calls-sdk-javascript";
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const getListItemView = (call: CallLog) => {
    if (call.getInitiator()) {
      return (
        <div
          style={{
            display: "flex",
            alignItems: "left",
            padding: "10px",
            border: "2px solid #e9baff",
            borderRadius: "20px",
            background: "#6e2bd9",
          }}
        >
          <cometchat-avatar
            image={call.getInitiator().getAvatar()}
            name={call.getInitiator().getName()}
          />
          <div style={{ display: "flex", paddingLeft: "10px" }}>
            <div
              style={{ fontWeight: "bold", color: "#ffffff", fontSize: "14px" }}
            >
              {call.getInitiator().getName()}
            </div>
          </div>
        </div>
      );
    } else {
      return <div>{call.getReceiver().getName()}</div>;
    }
  };

  return <CometChatCallLogs listItemView={getListItemView} />;
};

export default CallLogDemo;

SubtitleView​

You can customize the subtitle view for each call logs item to meet your requirements

subtitleView = { getSubtitleView };

Default:

Image

Custom:

Image
CallLogDemo.tsx
import { CallLog } from "@cometchat/calls-sdk-javascript";
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const getSubtitleView = (call: CallLog): JSX.Element => {
    return (
      <div
        style={{
          display: "flex",
          alignItems: "left",
          padding: "2px",
          fontSize: "10px",
        }}
      >
        <div style={{ color: "gray", fontSize: "15px" }}>
          {call.getStatus()}
        </div>
      </div>
    );
  };

  return <CometChatCallLogs subtitleView={getSubtitleView} />;
};

export default CallLogDemo;

TailView​

You can customize the tail view for each call logs item to meet your requirements

tailView = { getTailView };

Default:

Image

Custom:

Image
CallLogDemo.tsx
import { CallLog } from "@cometchat/calls-sdk-javascript";
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  function getTailView(call: CallLog): JSX.Element {
    function formatTime(timestamp: number) {
      const date = new Date(timestamp * 1000);
      return date.toLocaleString();
    }
    return (
      <div
        style={{
          color: "#5a00a8",
          border: "1px solid #5a00a8",
          borderRadius: "12px",
          padding: "5px",
        }}
      >
        {formatTime(call.getInitiatedAt())}
      </div>
    );
  }

  return <CometChatCallLogs tailView={getTailView} />;
};

export default CallLogDemo;

LoadingStateView​

You can set a custom loader view using loadingStateView to match the loading view of your app.

loadingStateView={getLoadingStateView()}

Default:

Image

Custom:

Image
CallLogDemo.tsx
import { CallLog } from "@cometchat/calls-sdk-javascript";
import { CometChatCallLogs, LoaderStyle } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const getLoadingStateView = () => {
    const getLoaderStyle = new LoaderStyle({
      iconTint: "#890aff",
      background: "red",
      height: "100vh",
      width: "100vw",
      border: "none",
      borderRadius: "0",
    });

    return (
      <div style={{ background: "red", position: "absolute", top: "0" }}>
        <cometchat-loader
          iconURL="icon"
          loaderStyle={JSON.stringify(getLoaderStyle)}
        ></cometchat-loader>
      </div>
    );
  };

  return <CometChatCallLogs loadingStateView={getLoadingStateView()} />;
};

export default CallLogDemo;

EmptyStateView​

You can set a custom EmptyStateView using emptyStateView to match the empty view of your app.

emptyStateView={getEmptyStateView()}

Default:

Image

Custom:

Image
CallLogDemo.tsx
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const getEmptyStateView = () => {
    return (
      <div style={{ color: "#d6cfff", fontSize: "30px", font: "bold" }}>
        Your Custom Empty State
      </div>
    );
  };

  return <CometChatCallLogs emptyStateView={getEmptyStateView()} />;
};

export default CallLogDemo;

ErrorStateView​

You can set a custom ErrorStateView using errorStateView to match the error view of your app.

errorStateView={getErrorStateView()}
CallLogDemo.tsx
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const getErrorStateView = () => {
    return (
      <div style={{ height: "100vh", width: "100vw" }}>
        <img
          src="custom image"
          alt="error icon"
          style={{
            height: "100px",
            width: "100px",
            marginTop: "250px",
            justifyContent: "center",
          }}
        ></img>
      </div>
    );
  };

  return <CometChatCallLogs errorStateView={getErrorStateView()} />;
};

export default CallLogDemo;

Configurations​

Configurations offer the ability to customize the properties of each component within a Composite Component.

CometChatCallLogs has OutGoing Call component. Hence, each of these components will have its individual `Configuration``.

  • Configurations expose properties that are available in its individual components.

OutGoing Call​

You can customize the properties of the OutGoing Call component by making use of the OutgoingCallConfiguration. You can accomplish this by employing the outgoingCallConfiguration props as demonstrated below:

outgoingCallConfiguration={new OutgoingCallConfiguration({
  //override properties of out going call
})}

All exposed properties of OutgoingCallConfiguration can be found under OutGoing Call. Properties marked with the report symbol are not accessible within the Configuration Object.

Example

Let's say you want to change the style of the OutGoing Call subcomponent and, in addition, you want to change the decline button icon.

You can modify the style using the outgoingCallStyle property and set custom decline button icon using declineButtonIconURL property.

Image
CallLogDemo.tsx
import {
  CometChatCallLogs,
  OutgoingCallConfiguration,
  OutgoingCallStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const outgoingCallStyle = new OutgoingCallStyle({
    background: "#e0d5f5",
    declineButtonIconBackground: "#6830d1",
    height: "500px",
    width: "300px",
    declineButtonTextColor: "#ffffff",
    titleTextColor: "#ffffff",
    subtitleTextColor: "#9213d6",
    declineButtonIconTint: "#dbb1f2",
    border: "1px solid #e6e6e6",
    borderRadius: "12px",
  });
  return (
    <CometChatCallLogs
      outgoingCallConfiguration={
        new OutgoingCallConfiguration({
          //override properties of out going call
          outgoingCallStyle: outgoingCallStyle,
          declineButtonIconURL: "custom decline button icon",
        })
      }
    />
  );
};

export default CallLogDemo;