Class Permission

Hierarchy

Permission

Index

Methods

Methods

isAllowAnyone

isAllowAnyone(): boolean

Check whether the collaboration can be joined by anyone with link.

You can udpate the permission by using Collaboration.updatePermission.

Returns boolean
- true : Anyone with the link can access the collaboration.
- false : Only the invited users can access the collaboration.
For example:
```
await collaboration.updatePermission({ isDocPublic: true})
```

isAllowComment

isAllowComment(): boolean

Check whether the current user is allowed to add comments in current collaboration.

You can udpate the permission by using Collaboration.updatePermission.

Returns boolean
- true：The current user is allowed to add comments.
- false: The current user only have view permission.
For example:
```
await collaboration.updatePermission({ isAllowComment: true })
```

isAllowMembers

isAllowMembers(): boolean

Check whether the collaboration can be joined only by invitation.

You can udpate the permission by using Collaboration.updatePermission.

Returns boolean
- true : Only the invited users can access the collaboration.
- false : Anyone with the link can access the collaboration.
For example:
```
await collaboration.updatePermission({ isDocPublic: false})
```

isMember

isMember(): boolean

Check whether the current user is member of the collaboration.

Returns boolean
- true: The current user is a member of collaboration.
- false: The current user is a owner of collaboration.

isOwner

isOwner(): boolean

Check whether the current user is owner of the collaboration.

Returns boolean
- true: The current user is a owner of collaboration.
- false: The current user is a member of collaboration.

Generated using TypeDoc