react-19-kit
Version:
Ready-to-use Chat UI Components for React(Javascript/Web)
52 lines (51 loc) • 1.86 kB
TypeScript
/**
* Props interface for the outgoing call component
*/
interface OutgoingCallProps {
/**
* The CometChat call object used to set up and launch the outgoing call.
*/
call?: CometChat.Call;
/**
* Disables the sound of outgoing calls.
* @defaultValue false
*/
disableSoundForCalls?: boolean;
/**
* Specifies a custom sound to play for outgoing calls.
*/
customSoundForCalls?: string;
/**
* Callback function triggered when an error occurs in the outgoing call component.
* @param error - An instance of `CometChat.CometChatException` representing the error.
* @return void
*/
onError?: ((error: CometChat.CometChatException) => void) | null;
/**
* Callback function triggered when the cancel button is clicked in the outgoing call component.
* @return void
*/
onCallCanceled?: Function;
/**
* This prop renders the custom title view for the outgoing call.
* Use this to override the existing title of user name from the outgoing call.
*/
titleView?: JSX.Element;
/**
* This prop renders the custom sub title view for the outgoing call.
* Use this to override the existing sub title text from the outgoing call.
*/
subtitleView?: JSX.Element;
/**
* This prop renders the custom avatar view for the outgoing call.
* Use this to override the existing avatar image from the outgoing call.
*/
avatarView?: JSX.Element;
/**
* This prop renders the custom cancel-call button view for the outgoing call.
* Use this to override the existing cancel call button view from the outgoing call.
*/
cancelButtonView?: JSX.Element;
}
declare const CometChatOutgoingCall: (props: OutgoingCallProps) => import("react/jsx-runtime").JSX.Element;
export { CometChatOutgoingCall };