fcr-ui-scene-mobile 3.4.0

package/lib/common/security-store.d.ts

@@ -0,0 +1,119 @@
+import { FcrPrivilegeControl, FcrStreamControl, FcrUserControl } from 'fcr-core';
+import { FcrUserRole, FcrUserInfo, FcrLineType } from 'fcr-core/lib/type';
+import { FcrUIEventStore } from './event-store';
+import { FcrSharePermissionState } from 'fcr-core/lib/room-control/whiteboard-control/enums';
+import { FcrPermissionAction, FcrPermissionInfo, FcrPrivilegeUserRole, FcrSecurityInfo, FcrSecuritySendChatPayload } from 'fcr-core/lib/room-control/privilege-control/type';
+export type FcrSecuritySendChatOriginalPayload = {
+    public: 0 | 1;
+    private: {
+        host: 0 | 1;
+        cohost: 0 | 1;
+        participant: 0 | 1;
+    };
+};
+export declare class FcrSecurityStore {
+    private _privilegeControl;
+    private _userControl;
+    private _streamControl;
+    private _uiEventStore;
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _disposers;
+    private _prevWaterMarkEnable;
+    accessor securityInfos: FcrSecurityInfo[];
+    accessor permissionInfos: FcrPermissionInfo[] | undefined;
+    accessor privilegeOperator: FcrUserInfo | undefined;
+    accessor boardOwnerUser: FcrUserInfo | undefined;
+    constructor(_privilegeControl: FcrPrivilegeControl, _userControl: FcrUserControl, _streamControl: FcrStreamControl, _uiEventStore: FcrUIEventStore);
+    release(): void;
+    private _setSecurityInfo;
+    private _setPermissionInfos;
+    get localUser(): FcrUserInfo;
+    allowChangeSelfName: () => boolean;
+    allowChat: () => boolean;
+    getWaterMarkContent: () => string;
+    convertSendChatPayload: (payload: FcrSecuritySendChatOriginalPayload) => FcrSecuritySendChatPayload;
+    allowedAllChat: () => boolean | undefined;
+    allowedPublicChatAndDisallowedPrivateChat: () => boolean | undefined;
+    disallowedPublicChatAndDisallowedPrivateChatToParticipant: () => boolean | undefined;
+    disallowedAllChat: () => boolean | undefined;
+    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;
+    isMulti: () => boolean;
+    getAllowedOperations(targetUserRole: FcrUserRole, _isSelf: boolean): string[];
+    allowShare(state: FcrSharePermissionState): Promise<void>;
+    setAllowWriteBoard(state: FcrSharePermissionState): Promise<void>;
+    muteAll: () => void;
+    unmuteAll: () => void;
+    setLockRoomEnabled: (enable: boolean) => void;
+    setWaitingRoomEnabled: () => void;
+    setAllowChangeSelfName: () => 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;
+    _hasPermission: (action: FcrPermissionAction, targetRole: FcrPrivilegeUserRole | FcrUserRole) => boolean;
+    _hasPermissionWithParams: (action: FcrPermissionAction, targetRole: FcrPrivilegeUserRole | FcrUserRole, params: Record<string, unknown>) => boolean;
+    private _handlePermissionUpdated;
+    private _handleSecurityUpdated;
+    permitPrivateChat(userId: string): boolean;
+    private _removeReactions;
+    setAllowWaterMark(state: boolean, lineType?: FcrLineType): Promise<void>;
+}