fcr-ui-scene 3.4.1 → 3.4.2

package/lib/providers/privilege-provider.d.ts

@@ -2,123 +2,436 @@ import { FcrPrivilegeControl, FcrStreamControl, FcrUserControl } from 'fcr-core'
 import { FcrUserRole, FcrUserInfo, FcrLineType } from 'fcr-core/lib/type';
 import { FcrSharePermissionState } from 'fcr-core/lib/room-control/whiteboard-control/enums';
 import { FcrPermissionInfo, FcrPrivilegeUserRole, FcrSecurityInfo, FcrSecuritySendChatPayload } from 'fcr-core/lib/room-control/privilege-control/type';
-import { FcrInterpreterControl } from 'fcr-core/lib/room-control/interpreter-control/types';
 import { FcrUISecuritySendChatOriginalPayload } from '../type';
-import { FcrUIEventProvider } from './event-provider';
 export interface FcrUIPrivilegeProvider {
+    /**
+     * 获取最后一次修改权限相关配置的用户信息
+     */
     get privilegeOperator(): FcrUserInfo | undefined;
+    /**
+     * 是否允许发送聊天消息（整体开关）
+     */
     allowChat(): boolean;
-    isMulti(): boolean;
+    /**
+     * 设置水印是否启用，以及水印是否多行显示
+     * @param isWaterMarkEnabled 是否启用水印
+     * @param type 行类型（单行或多行）
+     */
     setAllowWaterMark(isWaterMarkEnabled: boolean, type?: FcrLineType): void;
+    /**
+     * 是否允许用户自己修改昵称
+     */
     allowChangeSelfName(): boolean;
+    /**
+     * 用于调试，打印本地用户的全部权限信息
+     */
     printAllPermissions(): void;
+    /**
+     * 获取当前的水印字符串
+     */
     getWaterMarkContent(): string;
+    /**
+     * 是否允许用户发送公聊和私聊消息
+     */
     allowedAllChat(): boolean;
+    /**
+     * 检查当前用户是否有等候室相关权限
+     * @param role 目标角色（可选）
+     */
     hasWaitingRoomPermission(role?: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否允许公聊但不允许私聊
+     */
     allowedPublicChatAndDisallowedPrivateChat(): boolean;
+    /**
+     * 禁止公聊，只允许私聊主持人和联席主持人
+     */
     disallowedPublicChatAndDisallowedPrivateChatToParticipant(): boolean;
+    /**
+     * 是否禁止所有聊天
+     */
     disallowedAllChat(): boolean;
+    /**
+     * 是否允许用户在进入会议时默认静音
+     */
     allowJoinWithMuteAudio(): boolean;
+    /**
+     * 是否允许共享屏幕
+     */
     allowShareScreen(): boolean;
+    /**
+     * 是否允许用户修改昵称
+     */
     allowChangeSelfName(): boolean;
+    /**
+     * 是否允许聊天（同 allowChat）
+     */
     allowChat(): boolean;
+    /**
+     * 是否同时允许屏幕共享和白板操作
+     */
     allowScreenShareAndBoard(): boolean;
+    /**
+     * 是否允许在白板上书写
+     */
     allowBoardWrite(): boolean;
+    /**
+     * 是否允许用户自行开启视频
+     */
     allowUnmuteSelfVideo(): boolean;
+    /**
+     * 是否允许用户自行开启音频
+     */
     allowUnmuteSelfAudio(): boolean;
+    /**
+     * 是否已开启锁房间
+     */
     isLockRoomEnabled(): boolean;
+    /**
+     * 是否开启了等候室
+     */
     isWaitingRoomEnabled(): boolean;
+    /**
+     * 是否开启水印
+     */
     isWaterMarkEnabled(): boolean;
+    /**
+     * 当前用户是否拥有安全权限，如管理屏幕共享、聊天等
+     */
     get hasSecurityPermission(): boolean;
+    /**
+     * 是否有权限静音指定角色
+     * @param targetRole 目标角色
+     */
     hasMutePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否有权限停止对方的屏幕共享
+     * @param targetRole 目标角色
+     */
+    hasStopScreenSharePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否有权限取消静音（让目标角色可以开麦）
+     * @param targetRole 目标角色
+     */
     hasUnmutePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否有权限向目标角色发送请求，邀请其开启音频
+     * @param targetRole 目标角色
+     */
     hasRequestStartAudioPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否有权限向目标角色发送请求，邀请其开启视频
+     * @param targetRole 目标角色
+     */
     hasRequestStartVideoPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否可以直接开启目标角色的视频
+     * @param targetRole 目标角色
+     */
     hasStartVideoPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否可以关闭目标角色的视频
+     * @param targetRole 目标角色
+     */
     hasStopVideoPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否允许自己静音
+     */
     hasSelfMutePermission(): boolean;
+    /**
+     * 是否允许静音所有人
+     */
     hasAllMutePermission(): boolean;
+    /**
+     * 是否允许自己开启音频
+     */
     hasSelfUnmutePermission(): boolean;
+    /**
+     * 是否允许取消所有人的静音
+     */
     hasAllUnmutePermission(): boolean;
+    /**
+     * 是否允许撤销某位主持人的主持人身份
+     */
     hasRevokeHostPermission(): boolean;
+    /**
+     * 是否允许将某角色踢出房间
+     * @param targetRole 目标角色
+     */
     hasKickOutPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否拥有合并通话的权限
+     */
     hasCallMergePermission(): boolean;
+    /**
+     * 是否拥有分割通话的权限
+     */
     hasCallSplitPermission(): boolean;
+    /**
+     * 是否允许用户开始屏幕共享
+     */
     hasStartScreenSharePermission(): boolean;
+    /**
+     * 是否允许发送公聊消息
+     */
     hasChatSendPublicPermission(): boolean;
+    /**
+     * 是否允许对目标角色发送公聊消息
+     * @param targetRole 目标角色
+     */
     hasChatSendPublicPermissionByTargetRole(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否允许对目标角色发送私聊消息
+     * @param targetRole 目标角色
+     */
     hasPermissionToSendPrivateMessage(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否有“允许大家发送公聊消息”的权限
+     */
     hasPermissionToControlAllowSendAll(): boolean;
+    /**
+     * 是否有“禁止大家发送公聊消息”的权限
+     */
     hasPermissionToControlDisallowSendAll(): boolean;
+    /**
+     * 是否有“允许大家私聊”的权限
+     */
     hasPermissionToControlAllowSendPrivate(): boolean;
+    /**
+     * 是否有“禁止大家私聊”的权限
+     */
     hasPermissionToControlDisallowSendPrivate(): boolean;
+    /**
+     * 是否有设置角色的权限
+     * @param targetRole 当前目标角色
+     * @param setToRole 需要变更到的角色
+     */
     hasSetRolePermission(targetRole: FcrUserRole, setToRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否有启动云端录制的权限
+     */
     hasStartCloudRecordingPermission(): boolean;
+    /**
+     * 是否允许开启直播
+     */
     hasStartLiveStreamingPermission(): boolean;
+    /**
+     * 是否允许停止直播
+     */
     hasStopLiveStreamingPermission(): boolean;
+    /**
+     * 是否有权限获取直播链接
+     */
     hasGetLiveStreamingLinkPermission(): boolean;
+    /**
+     * 是否有权限启用用户开启音频
+     */
     hasEnableStartAudioPermission(): boolean;
+    /**
+     * 是否启用用户改名权限
+     */
     hasEnableChangeNamePermission(): boolean;
+    /**
+     * 是否有权限启用用户开启视频
+     */
     hasEnableStartVideoPermission(): boolean;
+    /**
+     * 是否让用户带音频进入会议
+     */
     hasEnableJoinWithAudioPermission(): boolean;
+    /**
+     * 是否有权限让用户开启屏幕共享
+     */
     hasEnableStartScreenSharePermission(): boolean;
+    /**
+     * 是否有锁定房间的权限
+     */
     hasLockRoomPermission(): boolean;
+    /**
+     * 是否有开启水印的权限
+     */
     hasWatermarkEnablePermission(): boolean;
+    /**
+     * 是否有关闭水印的权限
+     */
     hasWatermarkDisablePermission(): boolean;
+    /**
+     * 是否有结束当前房间的权限
+     */
     hasEndRoomPermission(): boolean;
+    /**
+     * 是否有在离开会议前，将主持人权限转交给他人的权限
+     * @param role 需要设置为的目标角色
+     */
     hasAssignHostBeforeLeavingPermission(role: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否允许开启白板
+     */
     hasStartBoardPermission(): boolean;
-    hasCloseBoardPermission(): boolean;
+    /**
+     * 是否允许关闭指定角色的白板
+     * @param targerRole 目标角色
+     */
+    hasCloseBoardPermission(targerRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 是否允许在白板上书写
+     */
     hasWriteBoardPermission(): boolean;
+    /**
+     * 是否允许开启白板操作（仅限于允许他人开启）
+     */
     hasAllowStartBoardPermission(): boolean;
+    /**
+     * 是否可禁止他人开启白板
+     */
     hasDisallowStartBoardPermission(): boolean;
+    /**
+     * 是否允许他人使用白板书写
+     */
     hasAllowWriteBoardPermission(): boolean;
+    /**
+     * 是否可禁止他人在白板书写
+     */
     hasDisallowWriteBoardPermission(): boolean;
+    /**
+     * 是否同时拥有屏幕共享和白板操作的权限
+     */
     hasAllowScreenShareAndBoardPermission(): boolean;
+    /**
+     * 是否允许开启水印
+     */
     hasAllowWaterMarkPermission(): boolean;
+    /**
+     * 是否允许开启译员功能
+     */
     hasEnableInterpreterPermission(): boolean;
+    /**
+     * 是否允许关闭译员功能
+     */
     hasDisableInterpreterPermission(): boolean;
+    /**
+     * 是否允许开启改名功能
+     */
     hasAllowChangeNamePermission(): boolean;
+    /**
+     * 是否允许禁止改名功能
+     */
     hasDisallowChangeNamePermission(): boolean;
+    /**
+     * 是否可以直接修改目标角色的昵称
+     * @param targetRole 目标角色
+     */
     hasChangeNamePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 获取针对某个角色的可用操作列表
+     * @param targetUserRole 目标用户角色
+     * @param isSelf 是否目标就是本地用户
+     */
     getAllowedOperations(targetUserRole: FcrUserRole, isSelf: boolean): string[];
+    /**
+     * 设置是否允许屏幕共享
+     * @param state 共享状态
+     */
     allowShare(state: FcrSharePermissionState): void;
+    /**
+     * 设置是否允许白板书写
+     * @param state 是否允许书写或传入状态
+     */
     setAllowWriteBoard(state: FcrSharePermissionState | boolean): void;
+    /**
+     * 是否有权限停止他人屏幕共享
+     * @param targetRole 目标角色
+     */
+    hasStopScreenSharePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    /**
+     * 将房间内所有用户静音
+     */
     muteAll(): void;
+    /**
+     * 请求所有用户取消静音
+     */
     unmuteAll(): void;
+    /**
+     * 是否允许聊天（同 allowChat）
+     */
     allowChat(): boolean;
+    /**
+     * 设置房间是否锁定
+     * @param enable 是否开启锁房间
+     */
     setLockRoomEnabled(enable: boolean): void;
+    /**
+     * 设置是否允许用户修改自己的昵称
+     * @param enable 是否允许
+     */
     setAllowChangeSelfName(enable: boolean): void;
+    /**
+     * 设置是否允许发送聊天消息（整体开关）
+     * @param enable 是否允许
+     */
     setAllowChat(enable: boolean): void;
+    /**
+     * 根据自定义配置设置公聊或私聊权限
+     * @param enable 是否启用聊天
+     * @param payload 公聊、私聊的配置信息
+     */
     setAllowChatWithPayload(enable: boolean, payload: FcrSecuritySendChatPayload): void;
+    /**
+     * 设置成允许公聊但不允许私聊
+     */
     setAllowedPublicChatAndDisallowedPrivateChat(): void;
+    /**
+     * 设置成不允许公聊，只允许群发给主持人和联席主持人
+     */
     setDisallowedPublicChatAndDisallowedPrivateChatToParticipant(): void;
+    /**
+     * 设置所有用户加入会议时默认静音
+     * @param enable 是否允许
+     */
     setAllowJoinWithMuteAudio(enable: boolean): void;
+    /**
+     * 允许或禁止屏幕共享
+     * @param state 是否允许
+     */
     setAllowShareScreen(state: boolean): void;
+    /**
+     * 是否允许用户自行开启视频
+     * @param enable 是否允许
+     */
     setAllowUnmuteSelfVideo(enable: boolean): void;
+    /**
+     * 是否允许用户自行开启音频
+     * @param enable 是否允许
+     */
     setAllowUnmuteSelfAudio(enable: boolean): void;
+    /**
+     * 是否允许发送公聊给所有人
+     */
     hasSendAllChatPermission(): boolean;
+    /**
+     * 检查是否允许对指定用户发送私聊消息，如果不允许会提示
+     * @param userId 目标用户ID
+     */
     permitPrivateChat(userId: string): boolean;
+    /**
+     * 判断当前水印是否使用多行显示
+     */
     isMulti(): boolean;
 }
 export declare class FcrUIPrivilegeProviderImpl implements FcrUIPrivilegeProvider {
-    private _eventProvider;
     private _privilegeControl;
     private _userControl;
     private _streamControl;
-    private _interpterControl?;
     protected logger: import("agora-foundation/lib/logger").Logger;
     private _disposers;
-    private _prevWaterMarkEnable;
+    private _localUser;
     accessor securityInfos: FcrSecurityInfo[];
     accessor permissionInfos: FcrPermissionInfo[];
     accessor privilegeOperator: FcrUserInfo | undefined;
-    accessor boardOwnerUser: FcrUserInfo | undefined;
     get hasSecurityPermission(): boolean;
-    constructor(_eventProvider: FcrUIEventProvider, _privilegeControl: FcrPrivilegeControl, _userControl: FcrUserControl, _streamControl: FcrStreamControl, _interpterControl?: FcrInterpreterControl | undefined);
+    constructor(_privilegeControl: FcrPrivilegeControl, _userControl: FcrUserControl, _streamControl: FcrStreamControl);
     printAllPermissions(): void;
     release(): void;
-    get localUser(): FcrUserInfo;
     allowChangeSelfName: () => boolean;
     allowChat: () => boolean;
     getWaterMarkContent: () => string;
@@ -138,6 +451,7 @@ export declare class FcrUIPrivilegeProviderImpl implements FcrUIPrivilegeProvide
     isWaterMarkEnabled: () => boolean;
     hasWaitingRoomPermission: (role?: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasMutePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasStopScreenSharePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasUnmutePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasRequestStartAudioPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasRequestStartVideoPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
@@ -175,7 +489,7 @@ export declare class FcrUIPrivilegeProviderImpl implements FcrUIPrivilegeProvide
     hasEndRoomPermission: () => boolean;
     hasAssignHostBeforeLeavingPermission: (role: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasStartBoardPermission: () => boolean;
-    hasCloseBoardPermission: () => boolean;
+    hasCloseBoardPermission: (targerRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
     hasWriteBoardPermission: () => boolean;
     hasAllowStartBoardPermission: () => boolean;
     hasDisallowStartBoardPermission: () => boolean;
@@ -212,5 +526,4 @@ export declare class FcrUIPrivilegeProviderImpl implements FcrUIPrivilegeProvide
     private _handleSecurityUpdated;
     permitPrivateChat(userId: string): boolean;
     setAllowWaterMark(state: boolean, lineType?: FcrLineType): Promise<void>;
-    private _isLocalUserInterpreter;
 }