Skip to main content
Version: v4

Outgoing Call

Overview

The outgoing call component is a visual representation of a user-initiated call, whether it's a voice or video call. It serves as an interface for managing outgoing calls, providing users with essential options to control the call experience. This component typically includes information about the call recipient, call controls for canceling the call, and feedback on the call status, such as indicating when the call is in progress.

Image

The Outgoing Call is comprised of the following components:

ComponentsDescription
cometchat-cardthis component displays structured content, often used for user profiles, chat messages, or group information in CometChat applications.
cometchat-labelThis component provides descriptive information about the associated UI element.
cometchat-icon-buttonThe CometChat IconButton component allows for the easy integration of customizable icon buttons

Usage

Integration

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

const OutgoingCallDemo = () => {
const [call, setCall] = React.useState<CometChat.Call>();

React.useEffect(() => {
const uid = "uid";

const callObject = new CometChat.Call(
uid,
CometChatUIKitConstants.MessageTypes.audio,
CometChatUIKitConstants.MessageReceiverType.user
);
CometChat.initiateCall(callObject)
.then((c) => {
setCall(c);
})
.catch(console.log);
}, []);

return call ? <CometChatOutgoingCall call={call} /> : null;
};

export default OutgoingCallDemo;

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. onCloseClicked

The onCloseClicked event gets activated when the close button is clicked. It does not have a default behavior. However, you can override its behavior using the following code snippet.

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
CometChatOutgoingCall,
CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
const [call, setCall] = React.useState<CometChat.Call>();

React.useEffect(() => {
const uid = "uid";

const callObject = new CometChat.Call(
uid,
CometChatUIKitConstants.MessageTypes.audio,
CometChatUIKitConstants.MessageReceiverType.user
);
CometChat.initiateCall(callObject)
.then((c) => {
setCall(c);
})
.catch(console.log);
}, []);

const cancelCall = () => {
//your custom close click actions
CometChat.endCall(call!.getSessionId()).then(() => {
setCall(undefined);
});
};
return call ? (
<CometChatOutgoingCall call={call} onCloseClicked={cancelCall} />
) : null;
};

export default OutgoingCallDemo;
2. onError

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

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
CometChatOutgoingCall,
CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
const [call, setCall] = React.useState<CometChat.Call>();

React.useEffect(() => {
const uid = "uid";

const callObject = new CometChat.Call(
uid,
CometChatUIKitConstants.MessageTypes.audio,
CometChatUIKitConstants.MessageReceiverType.user
);
CometChat.initiateCall(callObject)
.then((c) => {
setCall(c);
})
.catch(console.log);
}, []);

function handleOnError() {
//Your Custom Error Actions
}

return call ? (
<CometChatOutgoingCall call={call} onError={handleOnError} />
) : null;
};

export default OutgoingCallDemo;

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 ChatSDK.

The Outgoing 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 Outgoing Call component does not have any exposed filters.


Customization

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

To customize the appearance, you can assign a OutgoingCallStyle object to the Outgoing Call component.

Image

Example

In this example, we are employing the outgoingCallStyle.

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
CometChatOutgoingCall,
CometChatUIKitConstants,
OutgoingCallStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
const [call, setCall] = React.useState<CometChat.Call>();

React.useEffect(() => {
const uid = "uid";

const callObject = new CometChat.Call(
uid,
CometChatUIKitConstants.MessageTypes.audio,
CometChatUIKitConstants.MessageReceiverType.user
);
CometChat.initiateCall(callObject)
.then((c) => {
setCall(c);
})
.catch(console.log);
}, []);

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 call ? (
<CometChatOutgoingCall call={call} outgoingCallStyle={outgoingCallStyle} />
) : null;
};

export default OutgoingCallDemo;

The following properties are exposed by OutgoingCallStyle:

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;
declineButtonTextFontUsed to set decline button text fontdeclineButtonTextFont?: string;
declineButtonTextColorUsed to set decline button text colordeclineButtonTextColor?: string;
declineButtonIconTintUsed to set decline button icon tintdeclineButtonIconTint?: string;
declineButtonIconBackgroundUsed to set decline button icon background colordeclineButtonIconBackground?: string;

2. Avatar Style

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

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
CometChatOutgoingCall,
CometChatUIKitConstants,
AvatarStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
const [call, setCall] = React.useState<CometChat.Call>();

React.useEffect(() => {
const uid = "uid";

const callObject = new CometChat.Call(
uid,
CometChatUIKitConstants.MessageTypes.audio,
CometChatUIKitConstants.MessageReceiverType.user
);
CometChat.initiateCall(callObject)
.then((c) => {
setCall(c);
})
.catch(console.log);
}, []);

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

return call ? (
<CometChatOutgoingCall call={call} avatarStyle={avatarStyle} />
) : null;
};

export default OutgoingCallDemo;

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

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
CometChatOutgoingCall,
CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
const [call, setCall] = React.useState<CometChat.Call>();

React.useEffect(() => {
const uid = "uid";

const callObject = new CometChat.Call(
uid,
CometChatUIKitConstants.MessageTypes.audio,
CometChatUIKitConstants.MessageReceiverType.user
);
CometChat.initiateCall(callObject)
.then((c) => {
setCall(c);
})
.catch(console.log);
}, []);

return call ? (
<CometChatOutgoingCall
call={call}
declineButtonText="Your Custom Decline Button Text"
disableSoundForCalls={false}
declineButtonIconURL="Your Custom Decline Button Icon URL"
/>
) : null;
};

export default OutgoingCallDemo;

Default:

Image

Custom:

Image

Below is a list of customizations along with corresponding code snippets

PropertyDescriptionCode
declineButtonTextUsed to set custom decline button textdeclineButtonText='Your Custom Decline Button Text'
declineButtonIconURLUsed to set custom decline button icon URLdeclineButtonIconURL='Your Custom Decline Button Icon URL'
customSoundForCallsUsed to set custom sound for callscustomSoundForCalls='Your Custom Sound For Calls'
disableSoundForCallsUsed to disable/enable the sound of Outgoing calls, by default it is set to falsedisableSoundForCalls={false}
callSets the call object for CometChatOutgoingCallcall={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.


CustomView

By using the customView property, you can modify the CustomView to meet your specific needs.

customView={getCustomView()}

Example

OutgoingCallDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
CometChatOutgoingCall,
CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
const [call, setCall] = React.useState<CometChat.Call>();

React.useEffect(() => {
const uid = "uid";

const callObject = new CometChat.Call(
uid,
CometChatUIKitConstants.MessageTypes.audio,
CometChatUIKitConstants.MessageReceiverType.user
);
CometChat.initiateCall(callObject)
.then((c) => {
setCall(c);
})
.catch(console.log);
}, []);
const getCustomView = () => {
return <div> Your Custom View</div>;
};
return call ? (
<CometChatOutgoingCall call={call} customView={getCustomView()} />
) : null;
};

export default OutgoingCallDemo;