agora-meeting-core/lib/agora-meeting-core/src/services/room-api.d.ts

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

import { ApiBase, ApiBaseInitializerParams } from './base';
export declare class RoomApi extends ApiBase {
    constructor(params: ApiBaseInitializerParams);
    api_joinRoom(parmas: any): Promise<any>;
    api_leaveRoom({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_userPermissionsUpdate({ roomId, userId, micAccess, cameraAccess, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        micAccess?: boolean | undefined;
        cameraAccess?: boolean | undefined;
    }): Promise<any>;
    api_permissionCLoseAll({ roomId, userId, micClose, cameraClose, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        micClose?: boolean | undefined;
        cameraClose?: boolean | undefined;
    }): Promise<any>;
    api_permissionCLoseSingle({ roomId, userId, targetUserId, micClose, cameraClose, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        targetUserId?: string | undefined;
        micClose?: boolean | undefined;
        cameraClose?: boolean | undefined;
    }): Promise<any>;
    api_kickout({ roomId, userId, targetUserId, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        targetUserId?: string | undefined;
    }): Promise<any>;
    api_transferHost({ roomId, userId, targetUserId, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        targetUserId?: string | undefined;
    }): Promise<any>;
    api_abandonHost({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_recordStart({ roomId, userId, roomUrl, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        roomUrl?: string | undefined;
    }): Promise<any>;
    api_recordStop({ roomId, userId, recordId, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        recordId?: string | undefined;
    }): Promise<any>;
    api_getRecordFiles({ roomId }: {
        roomId?: string | undefined;
    }): Promise<any>;
    api_permissionAcept({ roomId, userId, requestId, targetUserId, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        requestId?: string | undefined;
        targetUserId?: string | undefined;
    }): Promise<any>;
    api_permissionReject({ roomId, userId, requestId, targetUserId, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        requestId?: string | undefined;
        targetUserId?: string | undefined;
    }): Promise<any>;
    api_applyHost({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_permissionApply({ roomId, userId, micAccess, cameraAccess, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        micAccess?: boolean | undefined;
        cameraAccess?: boolean | undefined;
    }): Promise<any>;
    api_roomInfoUpdate({ roomId, userId, password }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        password?: string | undefined;
    }): Promise<any>;
    api_userInfoUpdate({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_shareScreenStart({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_shareScreenStop({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_whiteBoardStart({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_whiteBoardStop({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_whiteBoardInteract({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_WhiteBoardLeave({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_endRoom({ roomId, userId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
    }): Promise<any>;
    api_appointHost({ roomId, userId, targetUserId }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        targetUserId?: string | undefined;
    }): Promise<any>;
    api_sendMsg({ roomId, userId, message }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        message?: string | undefined;
    }): Promise<any>;
    api_updateUserProperties({ roomId, userId, properties, }: {
        roomId?: string | undefined;
        userId?: string | undefined;
        properties?: {} | undefined;
    }): Promise<any>;
    api_updateFlexRoomProperties({ roomId, properties }: {
        roomId?: string | undefined;
        properties?: {} | undefined;
    }): Promise<any>;
    api_deleteUserProperties({ roomId, userId, properties, }: {
        roomId: string;
        userId: string;
        properties: string[];
    }): Promise<any>;
}