mediasfu-reactjs/dist/types/methods/messageMethods/sendMessage.d.ts

MediaSFU Prebuilt ReactJS SDK - Compatible with React 18 & 19, TypeScript & JavaScript

import { Socket } from "socket.io-client";
import { CoHostResponsibility, ShowAlert } from "../../@types/types";
export interface SendMessageOptions {
    member: string;
    islevel: string;
    showAlert?: ShowAlert;
    coHostResponsibility: CoHostResponsibility[];
    coHost: string;
    chatSetting: string;
    message: string;
    roomName: string;
    messagesLength: number;
    receivers: string[];
    group: boolean;
    sender: string;
    socket: Socket;
}
export type SendMessageType = (options: SendMessageOptions) => Promise<void>;
/**
 * Sends a message to the specified room.
 *
 * @param {Object} options - The options for sending the message.
 * @param {string} options.member - The member sending the message.
 * @param {string} options.islevel - The level of the member.
 * @param {Function} options.showAlert - Function to show alert messages.
 * @param {Array} options.coHostResponsibility - List of co-host responsibilities.
 * @param {string} options.coHost - The co-host of the room.
 * @param {boolean} options.chatSetting - Chat setting for the room.
 * @param {string} options.message - The message to be sent.
 * @param {string} options.roomName - The name of the room.
 * @param {number} options.messagesLength - The current number of messages in the room.
 * @param {Array} options.receivers - List of receivers for the message.
 * @param {boolean} options.group - Indicates if the message is for a group.
 * @param {string} options.sender - The sender of the message.
 * @param {Object} options.socket - The socket instance for communication.
 *
 * @returns {Promise<void>} A promise that resolves when the message is sent.
 *
 * @throws Will throw an error if the message count limit is exceeded.
 * @throws Will throw an error if the message, sender, or receivers are not valid.
 * @throws Will throw an error if the user is not allowed to send a message in the event room.
 *
 * @example
 * ```typescript
 * launchMessages({
 *   updateIsMessagesModalVisible: (visible) => console.log("Modal visibility:", visible),
 *   isMessagesModalVisible: false,
 * });
 * ```
 */
export declare const sendMessage: ({ member, islevel, showAlert, coHostResponsibility, coHost, chatSetting, message, roomName, messagesLength, receivers, group, sender, socket, }: SendMessageOptions) => Promise<void>;
//# sourceMappingURL=sendMessage.d.ts.map