agora-edu-core-lb/lib/services/edu-sdk-api.d.ts

For publishing npm package agora-edu-core (Web & Electron). Get more information from https://docs.agora.io

import { ApiBase, ApiBaseInitializerParams } from './base';
declare type ConfigResult = {
    customerId: string;
    customerCertificate: string;
    vid: number;
    netless: {
        appId: string;
        token: string;
        oss: {
            region: string;
            bucket: string;
            folder: string;
            accessKey: string;
            secretKey: string;
            endpoint: string;
        };
    };
    recordUrl: string;
};
declare type ConfigParams = Pick<ApiBaseInitializerParams, 'sdkDomain' | 'appId'>;
export declare class EduSDKApi extends ApiBase {
    constructor(params: ApiBaseInitializerParams);
    updateConfig(params: ConfigParams): void;
    updateRtmInfo(info: {
        rtmToken: string;
        rtmUid: string;
    }): void;
    getConfig(): Promise<ConfigResult>;
    reportCameraState(payload: {
        roomUuid: string;
        userUuid: string;
        state: number;
    }): Promise<any>;
    reportMicState(payload: {
        roomUuid: string;
        userUuid: string;
        state: number;
    }): Promise<any>;
    checkIn(params: {
        roomUuid: string;
        roomName: string;
        roomType: number;
        userName: string;
        userUuid: string;
        role: number;
        startTime?: number;
        duration?: number;
        region?: string;
        userProperties?: Record<string, any>;
    }): Promise<any>;
    updateClassState(params: {
        roomUuid: string;
        state: number;
    }): Promise<any>;
    updateRecordingState(params: {
        roomUuid: string;
        state: number;
        url?: string;
    }): Promise<any>;
    getHistoryChatMessage(params: {
        roomUuid: string;
        userUuid: string;
        data: {
            nextId: string;
            sort: number;
        };
    }): Promise<any>;
    muteStudentChat(params: {
        roomUuid: string;
        userUuid: string;
    }): Promise<void>;
    unmuteStudentChat(params: {
        roomUuid: string;
        userUuid: string;
    }): Promise<any>;
    getConversationHistoryChatMessage(params: {
        roomUuid: string;
        data: {
            nextId: string;
            sort: number;
            studentUuid: string;
        };
    }): Promise<any>;
    getConversationList(params: {
        roomUuid: string;
        data: {
            nextId: string;
        };
    }): Promise<any>;
    sendChat(params: {
        roomUuid: string;
        userUuid: string;
        data: {
            message: string;
            type: number;
        };
    }): Promise<any>;
    sendConversationChat(params: {
        roomUuid: string;
        userUuid: string;
        data: {
            message: string;
            type: number;
        };
    }): Promise<any>;
    muteChat(params: {
        roomUuid: string;
        muteChat: number;
    }): Promise<any>;
    sendRewards(params: {
        roomUuid: string;
        rewards: Array<{
            userUuid: string;
            changeReward: number;
        }>;
    }): Promise<any>;
    handsUp(params: {
        roomUuid: string;
        toUserUuid: string;
        payload: any;
    }): Promise<any>;
    allowHandsUp(params: {
        roomUuid: string;
        state: string;
    }): Promise<any>;
    startHandsUp(params: {
        roomUuid: string;
        toUserUuid: string;
    }): Promise<any>;
    dismissHandsUp(params: {
        roomUuid: string;
        toUserUuid: string;
    }): Promise<any>;
    cancelHandsUp(params: {
        roomUuid: string;
        toUserUuid?: string;
    }): Promise<any>;
    acceptHandsUp(params: {
        roomUuid: string;
        toUserUuid: string;
    }): Promise<any>;
    refuseHandsUp(params: {
        roomUuid: string;
        toUserUuid: string;
    }): Promise<any>;
    revokeCoVideo(params: {
        roomUuid: string;
        toUserUuid?: string;
    }): Promise<any>;
    revokeAllCoVideo(params: {
        roomUuid: string;
    }): Promise<any>;
    kickOutOnce(params: {
        roomUuid: string;
        toUserUuid: string;
    }): Promise<any>;
    kickOutBan(params: {
        roomUuid: string;
        toUserUuid: string;
    }): Promise<any>;
    selectShare(roomId: string, userUuid: string, payload: {
        selected: number;
    }): Promise<any>;
    startShareScreen(roomId: string, userUuid: string): Promise<any>;
    stopShareScreen(roomId: string, userUuid: string): Promise<any>;
    updateExtAppProperties(roomId: string, extAppUuid: string, properties: any, common: any, cause: any): Promise<any>;
    deleteExtAppProperties(roomId: string, extAppUuid: string, properties: string[], cause: any): Promise<any>;
    updateFlexProperties(roomId: string, properties: any, cause: any): Promise<any>;
    startPrivateChat(roomId: string, toUserUuid: string): Promise<any>;
    stopPrivateChat(roomId: string, toUserUuid: string): Promise<any>;
    /**
     * 开始轮播
     */
    startCarousel(payload: any): Promise<any>;
    /**
     * 停止轮播
     */
    stopCarousel(payload: any): Promise<any>;
}
export declare const eduSDKApi: EduSDKApi;
export {};