Skip to main content
Version: v4

Incoming Call

Overview​

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.

Image

The Incoming Call is comprised of the following base components:

ComponentsDescription
cometchat-list-itemThis component’s view consists of avatar, status indicator , title, and subtitle. The fields are then mapped with the SDK’s user, group class.
cometchat-iconThis component displays an icon. It currently supports only svg icons
cometchat-labelThis component provides descriptive information about the associated UI element.
cometchat-buttonThis component represents a button with optional icon and text.
cometchat-avatarThis component component displays an image or user's avatar with fallback to the first two letters of the username

Usage​

Integration​

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

const IncomingCallsDemo = () => {
  return <CometChatIncomingCall />;
};

export default IncomingCallsDemo;

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

onAccept is triggered when you click the accept button of the Incoming Call component. You can override this action using the following code snippet.

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

const IncomingCallsDemo = () => {
  const handleOnAccept = () => {
    console.log("custom on accept action");
  };

  return <CometChatIncomingCall onAccept={handleOnAccept} />;
};

export default IncomingCallsDemo;
2. onDecline​

onDecline is triggered when you click the Decline button of the Incoming Call component. You can override this action using the following code snippet.

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

const IncomingCallsDemo = () => {
  const handleOnDecline = () => {
    console.log("your custom on decline action");
  };

  return <CometChatIncomingCall onDecline={handleOnDecline} />;
};

export default IncomingCallsDemo;
3. onError​

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

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

const IncomingCallsDemo = () => {
  const handleOnError = () => {
    console.log("your custom on error action");
  };

  return <CometChatIncomingCall onError={handleOnError} />;
};

export default IncomingCallsDemo;

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.

The Incoming Call component does not have any exposed filters.

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 Incoming Call component is as follows.

EventDescription
ccCallRejectedThis event is triggered when the initiated call is rejected by the receiver.
ccCallAcceptedThis event is triggered when the initiated call is accepted by the receiver.
ccCallEndedThis event is triggered when the initiated call successfully ends.
const ccCallRejected = CometChatCallEvents.ccCallRejected.subscribe(
  (call: CometChat.Call) => {
    //Your Code
  }
);

const ccCallAccepted = CometChatCallEvents.ccCallAccepted.subscribe(
  (call: CometChat.Call) => {
    //Your Code
  }
);

const ccCallEnded = CometChatCallEvents.ccCallEnded.subscribe(
  (call: CometChat.Call) => {
    //Your Code
  }
);
ccCallRejected?.unsubscribe();

ccCallAccepted?.unsubscribe();

ccCallEnded?.unsubscribe();

Customization​

To fit your app's design requirements, you can customize the appearance of the Incoming Call 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. IncomingCall Style​

To customize the appearance, you can assign a IncomingCallStyle object to the Incoming Call component.

Image

Example

In this example, we are employing the IncomingCallStyle.

IncomingCallsDemo.tsx
import {
  CometChatIncomingCall,
  IncomingCallStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const incomingCallStyle = new IncomingCallStyle({
    acceptButtonBackground: "#7b49de",
    acceptButtonTextColor: "#ffffff",
    background: "#8761d4",
    declineButtonBackground: "#4b08d1",
  });

  return <CometChatIncomingCall incomingCallStyle={incomingCallStyle} />;
};

export default IncomingCallsDemo;

The following properties are exposed by IncomingCallStyle:

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;
titleTextFontUsed to set title text fonttitleTextFont?: string,
titleTextColorUsed to set title text colortitleTextColor?: string;
subtitleTextFontUsed to set subtitle text fontsubtitleTextFont?: string;
subtitleTextColorUsed to set subtitle text colorsubtitleTextColor?: string;
acceptButtonTextFontUsed to set accept button text fontacceptButtonTextFont?: string;
acceptButtonTextColorUsed to set accept button text coloracceptButtonTextColor?: string;
acceptButtonBackgroundUsed to set accept button background coloracceptButtonBackground?: string;
acceptButtonBorderRadiusUsed to set accept button border radiusacceptButtonBorderRadius?: string;
acceptButtonBorderUsed to set accept button borderacceptButtonBorder?: string;
declineButtonTextFontUsed to set decline button text fontdeclineButtonTextFont?: string;
declineButtonTextColorUsed to set decline button text colordeclineButtonTextColor?: string;
declineButtonBackgroundUsed to set decline button background colordeclineButtonBackground?: string;
declineButtonBorderRadiusUsed to set decline button border radiusdeclineButtonBorderRadius?: string;
declineButtonBorderUsed to set decline button borderdeclineButtonBorder?: string;
2. Avatar Style​

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

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

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

  return <CometChatIncomingCall avatarStyle={avatarStyle} />;
};

export default IncomingCallsDemo;
3. ListItem Style​

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

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

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

  return <CometChatIncomingCall listItemStyle={listItemStyle} />;
};

export default IncomingCallsDemo;

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 Incoming Call component.

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

const IncomingCallsDemo = () => {
  return (
    <CometChatIncomingCall
      acceptButtonText="Your Custom Accept Button Text"
      declineButtonText="Your Decline Button Text"
      disableSoundForCalls={true}
    />
  );
};

export default IncomingCallsDemo;

Default:

Image

Custom:

Image

Below is a list of customizations along with corresponding code snippets

PropertyDescriptionCode
acceptButtonTextUsed to set custom accept button textacceptButtonText='Your Custom Accept Button Text'
declineButtonTextUsed to set custom decline button textdeclineButtonText='Your Decline Button Text'
customSoundForCallsUsed to set custom sound for incoming callscustomSoundForCalls='Your Custom Sound For Calls'
disableSoundForCallsUsed to disable/enable the sound of incoming calls, by default it is set to falsedisableSoundForCalls={true}
callCometChat call object consumed by the component to launch itselfcall={callObject}

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.

SubtitleView​

By using the subtitleView property, you can modify the SubtitleView to meet your specific needs.

subtitleView = { getSubtitleView };

Example

Default:

Image

Custom:

Image
IncomingCallsDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getSubtitleView = (user: CometChat.User): JSX.Element => {
    function formatTime(timestamp: number) {
      const date = new Date(timestamp * 1000);
      return date.toLocaleString();
    }
    if (user instanceof CometChat.User) {
      return (
        <div
          style={{
            display: "flex",
            alignItems: "left",
            padding: "2px",
            fontSize: "10px",
          }}
        >
          <div style={{ color: "gray" }}>
            Last Active At: {formatTime(user.getLastActiveAt())}
          </div>
        </div>
      );
    } else {
      return <></>;
    }
  };

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

export default IncomingCallsDemo;