agora-edu-core/lib/stores/domain/common/user/struct.d.ts

Core APIs for building an online classroom

import { AgoraUser } from 'agora-rte-sdk';
import { EduRoleTypeEnum, EduRoomTypeEnum } from '../../../..';
/**
 * 用户对象
 */
/** @en
 * User object
 */
export declare class EduUser {
    userUuid: string;
    userName: string;
    userRole: EduRoleTypeEnum;
    userProperties: Map<string, any>;
    constructor(user: AgoraUser);
    toPlainObject(): {
        userUuid: string;
        userName: string;
        userRole: EduRoleTypeEnum;
        userProperties: Map<string, any>;
    };
}
/**
 * 用户对象
 */
/** @en
 * Plain user object
 */
export declare type EduUserStruct = {
    userUuid: string;
    userName: string;
    userRole: EduRoleTypeEnum;
    userProperties: any;
};
/**
 * 教室会话信息
 */
/** @en
 * Classroom session information
 */
export interface IAgoraUserSessionInfo {
    roomUuid: string;
    roomName: string;
    roomType: EduRoomTypeEnum;
    userUuid: string;
    userName: string;
    role: EduRoleTypeEnum;
}
/**
 * 教室会话信息
 */
/** @en
 * Classroom session information
 */
export declare class EduUserSessionInfo {
    roomUuid: string;
    roomName: string;
    roomType: EduRoomTypeEnum;
    userUuid: string;
    userName: string;
    role: EduRoleTypeEnum;
    constructor(data: IAgoraUserSessionInfo);
}