mediasfu-reactjs/dist/types/methods/streamMethods/clickChat.d.ts

MediaSFU Prebuilt ReactJS SDK

import { ShowAlert } from "../../@types/types";
export interface ClickChatOptions {
    isMessagesModalVisible: boolean;
    updateIsMessagesModalVisible: (isVisible: boolean) => void;
    chatSetting: string;
    islevel: string;
    showAlert?: ShowAlert;
}
export type ClickChatType = (options: ClickChatOptions) => Promise<void>;
/**
 * Toggles the visibility of the chat modal based on the current state and event settings.
 *
 * @param {Object} options - The options for the clickChat function.
 * @param {boolean} options.isMessagesModalVisible - Indicates if the messages modal is currently visible.
 * @param {Function} options.updateIsMessagesModalVisible - Function to update the visibility state of the messages modal.
 * @param {string} options.chatSetting - The chat setting for the event, which can be "allow" or other values.
 * @param {string} options.islevel - The participant's level, where "2" indicates a level that allows chat.
 * @param {Function} [options.showAlert] - Optional function to show an alert message.
 *
 * @returns {Promise<void>} A promise that resolves when the operation is complete.
 *
 * @example
 * ```typescript
 * clickChat({
 *   isMessagesModalVisible: false,
 *   updateIsMessagesModalVisible: setIsMessagesModalVisible,
 *   chatSetting: "allow",
 *   islevel: "1",
 *   showAlert: showAlertFunction
 * });
 * ```
 */
export declare const clickChat: ({ isMessagesModalVisible, updateIsMessagesModalVisible, chatSetting, islevel, showAlert }: ClickChatOptions) => Promise<void>;
//# sourceMappingURL=clickChat.d.ts.map