mediasfu-reactjs/dist/types/methods/utils/generateRandomMessages.d.ts

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

import { Message, Participant } from "../../@types/types";
export interface GenerateRandomMessagesOptions {
    participants: Participant[];
    member: string;
    coHost?: string;
    host: string;
    forChatBroadcast?: boolean;
}
export type GenerateRandomMessagesType = (options: GenerateRandomMessagesOptions) => Message[];
/**
 * Generates random messages for a given set of participants.
 *
 * @param {Object} options - The options for generating random messages.
 * @param {Array} options.participants - The list of participants.
 * @param {string} options.member - The member who is part of the chat.
 * @param {string} [options.coHost=""] - The co-host of the chat.
 * @param {string} options.host - The host of the chat.
 * @param {boolean} [options.forChatBroadcast=false] - Flag to indicate if the messages are for chat broadcast.
 * @returns {Message[]} An array of generated messages.
 *
 * @example
 * ```typescript
 * generateRandomMessages({
 *   participants: [{ name: "Alice" }, { name: "Bob" }],
 *   member: "Alice",
 *   host: "Bob",
 *   coHost: "Carol",
 *   forChatBroadcast: true,
 * });
 * // Returns an array of Message objects with random direct and group messages.
 * ```
 */
declare const generateRandomMessages: ({ participants, member, coHost, host, forChatBroadcast }: GenerateRandomMessagesOptions) => Message[];
export { generateRandomMessages };
//# sourceMappingURL=generateRandomMessages.d.ts.map