Skip to main content
Version: v5

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, customizable background and a list view.
CometChatListItemA component that renders data obtained from a Group object on a Tile having a title, subtitle, leading and trailing view.
CometChatDateThis component used to show the date and time. You can also customize the appearance of this widget by modifying its logic.

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 a callback function which triggers when a call log list item is clicked. It does not have a default behavior. However, you can override its behavior using the following code snippet.

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

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

export default CallLogDemo;
2. onCallButtonClicked​

onCallButtonClicked is a callback function which triggers when the call button in the trailing view is clicked.

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

const CallLogDemo = () => {
  const handleOnCallButtonClick = (callLog: any) => {
    console.log("custom on info click", callLog);
  };
  return <CometChatCallLogs onCallButtonClicked={handleOnCallButtonClick} />;
};

export default CallLogDemo;
3. onError​

This is a callback function which is triggered when the component encounters an error.

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

const CallLogDemo = () => {
  const handleOnError = (error: CometChat.CometChatException) => {
    console.log("your custom on error actions", error);
  };
  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.

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 CSS you can customize the look and feel of the component in your app like the color, size, shape, and fonts.

Example:

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

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

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.

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

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

export default CallLogDemo;

Below is a list of customizations along with corresponding code snippets

PropertyDescriptionCode
Date PatternSpecifies the date format for rendering dates in the call logs.datePattern={DatePatterns.DayDateTime}
Active CallObject representing the active call that is currently selected.activeCall={call}
Loading ViewA custom view to display when call logs are being loaded.loadingView={<>Custom Loading View</>}
Empty ViewA custom view to display when no call logs are available.emptyView={<>Custom Empty View</>}
Error ViewA custom view to display when an error occurs while fetching the call logs.errorView={<>Custom Error View</>}
Item ViewA function that renders a JSX element to display the item view.itemView={(call) => { return (<>Custom Item View</>)}}
Leading ViewA function that renders a JSX element to display the leading view.leadingView={(call) => { return (<>Custom Leading View</>)}}
Title ViewA function that renders a JSX element to display the title view.titleView={(call) => { return (<>Custom Title View</>)}}
Sub Title ViewA function that renders a JSX element to display the subtitle view.subtitleView={(call) => { return (<>Custom Sub Title View</>)}}
Trailing ViewA function that renders a JSX element to display the trailing view.trailingView={(call) => { return (<>Custom Trailing View</>)}}

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.

ItemView​

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

Shown below is the default chat interface.

Image

The customized chat interface is displayed below.

Image

Use the following code to achieve the customization shown above.

import {
  CometChatCallLogs,
  CometChatUIKitLoginListener,
  isMissedCall,
  isSentByMe,
  verifyCallUser,
} from "@cometchat/chat-uikit-react";
import { CometChatCallLogs } from "@cometchat/chat-uikit-react";

const CallLogDemo = () => {
  const getItemView = (call: any) => {
    const missedCall = isMissedCall(
      call,
      CometChatUIKitLoginListener?.getLoggedInUser()!
    );
    const isCallSentByMe = isSentByMe(
      call,
      CometChatUIKitLoginListener?.getLoggedInUser()!
    );

    let callStatus = missedCall
      ? "Missed Call"
      : isCallSentByMe
      ? "Outgoing Call"
      : "Incoming Call";

    let callIcon = missedCall
      ? missedIcon
      : isCallSentByMe
      ? outgoingIcon
      : incomingIcon;

    function formatDate(timestamp: number) {
      // Convert the timestamp from seconds to milliseconds
      const date = new Date(timestamp * 1000);

      // Define options for formatting
      const options: Object = {
        day: "2-digit",
        month: "short",
        hour: "2-digit",
        minute: "2-digit",
        hour12: true,
      };

      // Format the date with the specified options
      return date.toLocaleDateString("en-GB", options);
    }

    return (
      <div>
        <CometChatListItem
          title={verifyCallUser(
            call,
            CometChatUIKitLoginListener?.getLoggedInUser()!
          )?.getName()}
          subtitleView={callStatus}
          avatarURL={callIcon}
          trailingView={formatDate(call?.getInitiatedAt())}
        />
      </div>
    );
  };

  return <CometChatCallLogs itemView={getItemView} />;
};

export default CallLogDemo;

SubtitleView​

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

Shown below is the default chat interface.

Image

The customized chat interface is displayed below.

Image

Use the following code to achieve the customization shown above.

import {
  CometChatCallLogs,
  CometChatUIKitLoginListener,
  isMissedCall,
  isSentByMe,
} from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const getSubtitleView = (call: any): JSX.Element => {
    const missedCall = isMissedCall(
      call,
      CometChatUIKitLoginListener?.getLoggedInUser()!
    );
    const isCallSentByMe = isSentByMe(
      call,
      CometChatUIKitLoginListener?.getLoggedInUser()!
    );

    const iconClass = missedCall
      ? "cometchat-call-logs__list-item-subtitle-icon-missed-call"
      : isCallSentByMe
      ? "cometchat-call-logs__list-item-subtitle-icon-outgoing-call"
      : "cometchat-call-logs__list-item-subtitle-icon-incoming-call";

    const callStatus = missedCall
      ? "Missed Call"
      : isCallSentByMe
      ? "Outgoing Call"
      : "Incoming Call";

    return (
      <>
        <div className={`cometchat-call-logs__list-item-subtitle`}>
          <div
            className={`cometchat-call-logs__list-item-subtitle-icon ${iconClass}`}
          />
          <div className="cometchat-call-logs__list-item-subtitle-text">
            {" "}
            {callStatus}
          </div>
        </div>
      </>
    );
  };

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

export default CallLogDemo;

TrailingView​

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

Shown below is the default chat interface.

Image

The customized chat interface is displayed below.

Image

Use the following code to achieve the customization shown above.

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

const CallLogDemo = () => {
  function formatDate(timestamp: number) {
    // Convert the timestamp from seconds to milliseconds
    const date = new Date(timestamp * 1000);

    // Define options for formatting
    const options: Object = {
      day: "2-digit",
      month: "short",
      hour: "2-digit",
      minute: "2-digit",
      hour12: true,
    };

    // Format the date with the specified options
    return date.toLocaleDateString("en-GB", options);
  }

  const getTrailingView = (call: any) => {
    return (
      <div className="call-log-trailing-view">{formatDate(call?.getInitiatedAt())}</div>
    );
  };

  return <CometChatCallLogs trailingView={getTrailingView} />;
};

export default CallLogDemo;

LeadingView​

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

Shown below is the default chat interface.

Image

The customized chat interface is displayed below.

Image

Use the following code to achieve the customization shown above.

import { CallLog } from "@cometchat/calls-sdk-javascript";
import { CometChatUIKitLoginListener, CometChatCallLogs } from "@cometchat/chat-uikit-react";
import React from "react";

const CallLogDemo = () => {
  const getLeadingView = (call: any) => {
        const loggedInUser = CometChatUIKitLoginListener.getLoggedInUser();
        return (
            <div className="call-log-avatar">
                {call.status === "unanswered" || call.status === "cancelled" ? <div className="call-log-missed" /> :
                    call.initiator?.uid === loggedInUser?.getUid() ? <div className="call-log-outgoing" /> :
                        <div className="call-log-incoming" />
                }
            </div>
        );
    };

  return <CometChatCallLogs leadingView={getLeadingView} />;
};

export default CallLogDemo;

TitleView​

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

Shown below is the default chat interface.

Image

The customized chat interface is displayed below.

Image

Use the following code to achieve the customization shown above.

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

const CallLogDemo = () => {
  const getTitleView = (call: any) => {
        return (
            <div className="call-log-title">
                {call.initiator?.name}
                {call.status !== "unanswered" && call.status !== "cancelled" &&
                    <>
                        {" • 🕚️ " + Math.ceil(call.totalDurationInMinutes) + " mins"}
                    </>
                }
            </div>
        );
    };

  return <CometChatCallLogs titleView={getTitleView} />;
};

export default CallLogDemo;