FPresentationPermission

Command-backed permissions for one Presentation unit.

Access

Access through:

• FPresentation.getPermission()

Setup

Register @univerjs-pro/slides or a preset that includes it. In plugin mode, import @univerjs-pro/slides/facade. Additional methods below require their listed plugin packages. See Facade setup.

@univerjs-pro/slides

FPresentationPermission.canEdit

Returns whether the whole Presentation is currently editable.

canEdit(): boolean

Returns

Whether Presentation editing is allowed.

Package: @univerjs-pro/slides · Type definitions

FPresentationPermission.getPoint

Returns the current value of one Presentation unit permission.

getPoint(action: SlideUnitPermissionAction): boolean

Parameters

• action — Required. Unit permission action to query.

Returns

Whether the action is currently allowed.

Examples

import { UnitAction } from '@univerjs/protocol'const presentation = univerAPI.getActivePresentation()console.log(presentation?.getPermission().getPoint(UnitAction.Print))

Types: SlideUnitPermissionAction

Package: @univerjs-pro/slides · Type definitions

FPresentationPermission.setEditable

Enables or disables editing for the whole Presentation.

setEditable(editable?: boolean): Promise<void>

Parameters

• editable — Optional. Default: true. Whether editing is allowed. Defaults to true.

Returns

Resolves after the permission command finishes.

Types: Promise

Package: @univerjs-pro/slides · Type definitions

FPresentationPermission.setObjectPermissions

Creates or updates child-object edit policies in this unit; policy: null removes protection and restores inheritance.

Requires Authz support and objectPermissionTypes configured for every target type. File and parent restrictions still apply. Use the exported permission object ID helpers, not raw object IDs or server permission IDs. The batch must be nonempty, contain distinct objects, and belong to this unit; file-wide policies are excluded. Other targets use getSlideElementPermissionObjectId and SLIDE_MASTER_VIEW_PERMISSION_OBJECT_ID.

edit: 'all' allows Unit editors, 'owner' restricts editing to the object owner, and 'members' selects existing Unit collaborators. Pass their collaborator records from the member service; this does not invite new users. Use strategies: [] for the default Edit strategy; child-object strategies support only UnitAction.Edit.

Authz writes execute per object and can partially succeed. Inspect failed before retrying only those objects. refreshError means writes finished but permission readback failed; do not retry succeeded objects for that error. Successful binding changes share one undo entry; existing remote policy edits are not undoable.

setObjectPermissions(changes: IObjectPermissionChange[]): Promise<IObjectPermissionBatchResult>

Parameters

• changes — Required. Permission object IDs and policies to apply.

Returns

Successful object IDs, per-object failures, and optional readback error.

Throws

Invalid batches or unsupported object types are rejected before Authz writes.

Examples

Set owner/member editing and remove protection in one batch

import type { ICollaborator } from '@univerjs/protocol'import { getSlidePagePermissionObjectId } from '@univerjs-pro/slides'// selectedMembers comes from the existing Unit collaborator picker/service.async function applyPermissions(selectedMembers: ICollaborator[]) {  if (!selectedMembers.length) throw new Error('Select at least one Unit collaborator.')  const presentation = univerAPI.getActivePresentation()  if (!presentation) throw new Error('No active presentation.')  const objectIds = presentation    .getSlides()    .slice(0, 3)    .map((slide) => getSlidePagePermissionObjectId(slide.getId()))  if (objectIds.length < 3) throw new Error('This example requires three slides.')  const result = await presentation.getPermission().setObjectPermissions([    { objectId: objectIds[0], policy: { edit: 'owner', collaborators: [], strategies: [] } },    {      objectId: objectIds[1],      policy: { edit: 'members', collaborators: selectedMembers, strategies: [] },    },    { objectId: objectIds[2], policy: null },  ])  // A policy creates protection if absent, or updates the existing policy when already configured.  for (const failure of result.failed) {    console.error(failure.objectId, failure.error)  }  if (result.refreshError) {    console.error(result.refreshError)  }  return result}

Types: IObjectPermissionBatchResult · Promise · IObjectPermissionChange

Package: @univerjs-pro/slides · Type definitions

FPresentationPermission.setPoint

Sets one Presentation unit permission through the command system.

Supported actions are Edit, Copy, Print, Export, and Comment.

setPoint(action: SlideUnitPermissionAction, value: boolean): Promise<void>

Parameters

• action — Required. Unit permission action to update.
• value — Required. Whether the action is allowed.

Returns

Resolves after the permission command finishes.

Examples

import { UnitAction } from '@univerjs/protocol'const presentation = univerAPI.getActivePresentation()if (!presentation) throw new Error('No active Presentation.')await presentation.getPermission().setPoint(UnitAction.Export, false)

Types: Promise · SlideUnitPermissionAction

Package: @univerjs-pro/slides · Type definitions

FPresentationPermission.setReadOnly

Makes the whole Presentation read-only.

setReadOnly(): Promise<void>

Returns

Resolves after the permission command finishes.

Examples

const presentation = univerAPI.getActivePresentation()if (!presentation) throw new Error('No active Presentation.')await presentation.getPermission().setReadOnly()

Types: Promise

Package: @univerjs-pro/slides · Type definitions