接口: IWorkbookPermission

Workbook-level permission Facade interface

属性

方法

addCollaborator()

addCollaborator(user, role): Promise<void>

Add a single collaborator

参数

返回

Promise<void>

canEdit()

canEdit(): boolean

Whether current user can edit this workbook (calculated from combined permissions)

返回

boolean

getPoint()

getPoint(point): boolean

Read current value of a point (synchronous, reads from local state)

参数

返回

boolean

getSnapshot()

getSnapshot(): WorkbookPermissionSnapshot

Get snapshot of all current points

返回

WorkbookPermissionSnapshot

listCollaborators()

listCollaborators(): Promise<...[]>

List all collaborators

返回

Promise<…[]>

removeCollaborator()

removeCollaborator(userId): Promise<void>

Remove collaborator

参数

返回

Promise<void>

removeCollaborators()

removeCollaborators(userIds): Promise<void>

Batch remove collaborators

参数

返回

Promise<void>

setCollaborators()

setCollaborators(collaborators): Promise<void>

Batch set collaborators (replace mode, overwrites existing collaborator list)

参数

返回

Promise<void>

setEditable()

setEditable(): Promise<void>

Shortcut: Set workbook to editable (equivalent to setMode(‘editor’) or owner subset)

返回

Promise<void>

setMode()

setMode(mode): Promise<void>

High-level mode setting: By Owner / Editor / Viewer / Commenter semantics Internally automatically combines multiple WorkbookPermissionPoints

参数

返回

Promise<void>

setPoint()

setPoint(point, value): Promise<void>

Low-level point operations: Directly set boolean value of a WorkbookPermissionPoint

参数

返回

Promise<void>

setReadOnly()

setReadOnly(): Promise<void>

Shortcut: Set workbook to read-only (equivalent to setMode(‘viewer’))

返回

Promise<void>

subscribe()

subscribe(listener): UnsubscribeFn

Compatibility method: Simplified subscription (for users unfamiliar with RxJS) Internally implemented based on permission$ Observable

参数

返回

UnsubscribeFn

updateCollaborator()

updateCollaborator(user, role): Promise<void>

Update collaborator role and information

参数

返回

Promise<void>