mediasfu-reactjs/dist/types/producers/socketReceiveMethods/updateConsumingDomains.d.ts

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

import { ConnectIpsType, GetDomainsType, ConnectIpsParameters, GetDomainsParameters, AltDomains, Participant, ConsumeSocket } from "../../@types/types";
export interface UpdateConsumingDomainsParameters extends ConnectIpsParameters, GetDomainsParameters {
    participants: Participant[];
    consume_sockets: ConsumeSocket[];
    connectIps: ConnectIpsType;
    getDomains: GetDomainsType;
    getUpdatedAllParams: () => UpdateConsumingDomainsParameters;
    [key: string]: any;
}
export interface UpdateConsumingDomainsOptions {
    domains: string[];
    alt_domains: AltDomains;
    apiUserName: string;
    apiKey: string;
    apiToken: string;
    parameters: UpdateConsumingDomainsParameters;
}
export type UpdateConsumingDomainsType = (options: UpdateConsumingDomainsOptions) => Promise<void>;
/**
 * Updates the consuming domains based on provided options.
 *
 * @param {UpdateConsumingDomainsOptions} options - Options for updating consuming domains.
 * @param {string[]} options.domains - The primary domains to be updated.
 * @param {AltDomains} options.alt_domains - The alternative consuming domains for participants.
 * @param {string} options.apiUserName - API username for domain updates.
 * @param {string} options.apiKey - API key for authorization.
 * @param {string} options.apiToken - API token for secure access.
 * @param {UpdateConsumingDomainsParameters} options.parameters - Additional parameters required for updating consuming domains.
 *
 * @returns {Promise<void>} Resolves when consuming domains have been successfully updated.
 *
 * @throws Logs an error if an issue occurs during the update process.
 *
 * @example
 * ```typescript
 * const options = {
 *   domains: ["domain1.com", "domain2.com"],
 *   alt_domains: { domainAlias: ["altDomain1.com"] },
 *   apiUserName: "myApiUser",
 *   apiKey: "myApiKey",
 *   apiToken: "myApiToken",
 *   parameters: {
 *     participants: [{ id: "user1", name: "User 1" }],
 *     consume_sockets: [{ id: "socket1", isConnected: true }],
 *     connectIps: async (options) => { console.log("Connecting IPs", options); },
 *     getDomains: async (options) => { console.log("Getting Domains", options); },
 *     getUpdatedAllParams: () => ({ consume_sockets: [{ id: "socket1", isConnected: true }] }),
 *   },
 * };
 *
 * await updateConsumingDomains(options);
 * ```
 */
export declare const updateConsumingDomains: ({ domains, alt_domains, parameters, apiUserName, apiKey, apiToken }: UpdateConsumingDomainsOptions) => Promise<void>;
//# sourceMappingURL=updateConsumingDomains.d.ts.map