fcr-ui-scene 3.4.0 → 3.4.1

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

@@ -0,0 +1,216 @@
+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;
+    setAllowWaterMark(isWaterMarkEnabled: boolean, type?: FcrLineType): void;
+    allowChangeSelfName(): boolean;
+    printAllPermissions(): void;
+    getWaterMarkContent(): string;
+    allowedAllChat(): boolean;
+    hasWaitingRoomPermission(role?: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    allowedPublicChatAndDisallowedPrivateChat(): boolean;
+    disallowedPublicChatAndDisallowedPrivateChatToParticipant(): boolean;
+    disallowedAllChat(): boolean;
+    allowJoinWithMuteAudio(): boolean;
+    allowShareScreen(): boolean;
+    allowChangeSelfName(): boolean;
+    allowChat(): boolean;
+    allowScreenShareAndBoard(): boolean;
+    allowBoardWrite(): boolean;
+    allowUnmuteSelfVideo(): boolean;
+    allowUnmuteSelfAudio(): boolean;
+    isLockRoomEnabled(): boolean;
+    isWaitingRoomEnabled(): boolean;
+    isWaterMarkEnabled(): boolean;
+    get hasSecurityPermission(): boolean;
+    hasMutePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasUnmutePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasRequestStartAudioPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasRequestStartVideoPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasStartVideoPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasStopVideoPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasSelfMutePermission(): boolean;
+    hasAllMutePermission(): boolean;
+    hasSelfUnmutePermission(): boolean;
+    hasAllUnmutePermission(): boolean;
+    hasRevokeHostPermission(): boolean;
+    hasKickOutPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasCallMergePermission(): boolean;
+    hasCallSplitPermission(): boolean;
+    hasStartScreenSharePermission(): boolean;
+    hasChatSendPublicPermission(): boolean;
+    hasChatSendPublicPermissionByTargetRole(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasPermissionToSendPrivateMessage(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasPermissionToControlAllowSendAll(): boolean;
+    hasPermissionToControlDisallowSendAll(): boolean;
+    hasPermissionToControlAllowSendPrivate(): boolean;
+    hasPermissionToControlDisallowSendPrivate(): boolean;
+    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;
+    hasAssignHostBeforeLeavingPermission(role: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasStartBoardPermission(): boolean;
+    hasCloseBoardPermission(): boolean;
+    hasWriteBoardPermission(): boolean;
+    hasAllowStartBoardPermission(): boolean;
+    hasDisallowStartBoardPermission(): boolean;
+    hasAllowWriteBoardPermission(): boolean;
+    hasDisallowWriteBoardPermission(): boolean;
+    hasAllowScreenShareAndBoardPermission(): boolean;
+    hasAllowWaterMarkPermission(): boolean;
+    hasEnableInterpreterPermission(): boolean;
+    hasDisableInterpreterPermission(): boolean;
+    hasAllowChangeNamePermission(): boolean;
+    hasDisallowChangeNamePermission(): boolean;
+    hasChangeNamePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    getAllowedOperations(targetUserRole: FcrUserRole, isSelf: boolean): string[];
+    allowShare(state: FcrSharePermissionState): void;
+    setAllowWriteBoard(state: FcrSharePermissionState | boolean): void;
+    muteAll(): void;
+    unmuteAll(): void;
+    allowChat(): boolean;
+    setLockRoomEnabled(enable: boolean): void;
+    setAllowChangeSelfName(enable: boolean): void;
+    setAllowChat(enable: boolean): void;
+    setAllowChatWithPayload(enable: boolean, payload: FcrSecuritySendChatPayload): void;
+    setAllowedPublicChatAndDisallowedPrivateChat(): void;
+    setDisallowedPublicChatAndDisallowedPrivateChatToParticipant(): void;
+    setAllowJoinWithMuteAudio(enable: boolean): void;
+    setAllowShareScreen(state: boolean): void;
+    setAllowUnmuteSelfVideo(enable: boolean): void;
+    setAllowUnmuteSelfAudio(enable: boolean): void;
+    hasSendAllChatPermission(): boolean;
+    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;
+    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);
+    printAllPermissions(): void;
+    release(): void;
+    get localUser(): FcrUserInfo;
+    allowChangeSelfName: () => boolean;
+    allowChat: () => boolean;
+    getWaterMarkContent: () => string;
+    convertSendChatPayload: (payload: FcrUISecuritySendChatOriginalPayload) => FcrSecuritySendChatPayload;
+    allowedAllChat: () => boolean;
+    allowedPublicChatAndDisallowedPrivateChat: () => boolean;
+    disallowedPublicChatAndDisallowedPrivateChatToParticipant: () => boolean;
+    disallowedAllChat: () => boolean;
+    allowJoinWithMuteAudio: () => boolean;
+    allowShareScreen: () => boolean;
+    allowScreenShareAndBoard: () => boolean;
+    allowBoardWrite: () => boolean;
+    allowUnmuteSelfVideo: () => boolean;
+    allowUnmuteSelfAudio: () => boolean;
+    isLockRoomEnabled: () => boolean;
+    isWaitingRoomEnabled: () => boolean;
+    isWaterMarkEnabled: () => boolean;
+    hasWaitingRoomPermission: (role?: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasMutePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasUnmutePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasRequestStartAudioPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasRequestStartVideoPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasStartVideoPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasStopVideoPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasSelfMutePermission: () => boolean;
+    hasAllMutePermission: () => boolean;
+    hasSelfUnmutePermission: () => boolean;
+    hasAllUnmutePermission: () => boolean;
+    hasRevokeHostPermission: () => boolean;
+    hasKickOutPermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasCallMergePermission: () => boolean;
+    hasCallSplitPermission: () => boolean;
+    hasStartScreenSharePermission: () => boolean;
+    hasChatSendPublicPermission: () => boolean;
+    hasChatSendPublicPermissionByTargetRole: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasPermissionToSendPrivateMessage: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasPermissionToControlAllowSendAll: () => boolean;
+    hasPermissionToControlDisallowSendAll: () => boolean;
+    hasPermissionToControlAllowSendPrivate: () => boolean;
+    hasPermissionToControlDisallowSendPrivate: () => boolean;
+    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;
+    hasAssignHostBeforeLeavingPermission: (role: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    hasStartBoardPermission: () => boolean;
+    hasCloseBoardPermission: () => boolean;
+    hasWriteBoardPermission: () => boolean;
+    hasAllowStartBoardPermission: () => boolean;
+    hasDisallowStartBoardPermission: () => boolean;
+    hasAllowWriteBoardPermission: () => boolean;
+    hasDisallowWriteBoardPermission: () => boolean;
+    hasAllowScreenShareAndBoardPermission: () => boolean;
+    hasAllowWaterMarkPermission: () => boolean;
+    hasEnableInterpreterPermission: () => boolean;
+    hasDisableInterpreterPermission: () => boolean;
+    hasAllowChangeNamePermission: () => boolean;
+    hasDisallowChangeNamePermission: () => boolean;
+    hasChangeNamePermission: (targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    isMulti: () => boolean;
+    getAllowedOperations: (targetUserRole: FcrUserRole, isSelf: boolean) => string[];
+    allowShare: (state: FcrSharePermissionState) => Promise<void>;
+    setAllowWriteBoard: (state: FcrSharePermissionState | boolean) => Promise<void>;
+    muteAll: () => void;
+    unmuteAll: () => void;
+    setLockRoomEnabled: (enable: boolean) => void;
+    setWaitingRoomEnabled: () => void;
+    setAllowChangeSelfName: (enable: boolean) => void;
+    setAllowChat: (enable: boolean) => void;
+    setAllowChatWithPayload: (enable: boolean, payload: FcrSecuritySendChatPayload) => void;
+    setAllowedPublicChatAndDisallowedPrivateChat: () => void;
+    setDisallowedPublicChatAndDisallowedPrivateChatToParticipant: () => void;
+    setAllowJoinWithMuteAudio: (enable: boolean) => void;
+    setAllowShareScreen: (state: boolean) => void;
+    setAllowUnmuteSelfVideo: (enable: boolean) => void;
+    setAllowUnmuteSelfAudio: (enable: boolean) => void;
+    hasSendAllChatPermission: () => boolean;
+    private _hasPermission;
+    private _hasPermissionWithParams;
+    private _handlePermissionUpdated;
+    private _handleSecurityUpdated;
+    permitPrivateChat(userId: string): boolean;
+    setAllowWaterMark(state: boolean, lineType?: FcrLineType): Promise<void>;
+    private _isLocalUserInterpreter;
+}